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 * Return an exact copy of the specified module. 565 */ 566 LLVMModuleRef LLVMCloneModule(LLVMModuleRef M); 567 568 /** 569 * Destroy a module instance. 570 * 571 * This must be called for every created module or memory will be 572 * leaked. 573 */ 574 void LLVMDisposeModule(LLVMModuleRef M); 575 576 /** 577 * Obtain the data layout for a module. 578 * 579 * @see Module::getDataLayout() 580 */ 581 const char *LLVMGetDataLayout(LLVMModuleRef M); 582 583 /** 584 * Set the data layout for a module. 585 * 586 * @see Module::setDataLayout() 587 */ 588 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple); 589 590 /** 591 * Obtain the target triple for a module. 592 * 593 * @see Module::getTargetTriple() 594 */ 595 const char *LLVMGetTarget(LLVMModuleRef M); 596 597 /** 598 * Set the target triple for a module. 599 * 600 * @see Module::setTargetTriple() 601 */ 602 void LLVMSetTarget(LLVMModuleRef M, const char *Triple); 603 604 /** 605 * Dump a representation of a module to stderr. 606 * 607 * @see Module::dump() 608 */ 609 void LLVMDumpModule(LLVMModuleRef M); 610 611 /** 612 * Print a representation of a module to a file. The ErrorMessage needs to be 613 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise. 614 * 615 * @see Module::print() 616 */ 617 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename, 618 char **ErrorMessage); 619 620 /** 621 * Return a string representation of the module. Use 622 * LLVMDisposeMessage to free the string. 623 * 624 * @see Module::print() 625 */ 626 char *LLVMPrintModuleToString(LLVMModuleRef M); 627 628 /** 629 * Set inline assembly for a module. 630 * 631 * @see Module::setModuleInlineAsm() 632 */ 633 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm); 634 635 /** 636 * Obtain the context to which this module is associated. 637 * 638 * @see Module::getContext() 639 */ 640 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M); 641 642 /** 643 * Obtain a Type from a module by its registered name. 644 */ 645 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name); 646 647 /** 648 * Obtain the number of operands for named metadata in a module. 649 * 650 * @see llvm::Module::getNamedMetadata() 651 */ 652 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name); 653 654 /** 655 * Obtain the named metadata operands for a module. 656 * 657 * The passed LLVMValueRef pointer should refer to an array of 658 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This 659 * array will be populated with the LLVMValueRef instances. Each 660 * instance corresponds to a llvm::MDNode. 661 * 662 * @see llvm::Module::getNamedMetadata() 663 * @see llvm::MDNode::getOperand() 664 */ 665 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest); 666 667 /** 668 * Add an operand to named metadata. 669 * 670 * @see llvm::Module::getNamedMetadata() 671 * @see llvm::MDNode::addOperand() 672 */ 673 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name, 674 LLVMValueRef Val); 675 676 /** 677 * Add a function to a module under a specified name. 678 * 679 * @see llvm::Function::Create() 680 */ 681 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name, 682 LLVMTypeRef FunctionTy); 683 684 /** 685 * Obtain a Function value from a Module by its name. 686 * 687 * The returned value corresponds to a llvm::Function value. 688 * 689 * @see llvm::Module::getFunction() 690 */ 691 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name); 692 693 /** 694 * Obtain an iterator to the first Function in a Module. 695 * 696 * @see llvm::Module::begin() 697 */ 698 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M); 699 700 /** 701 * Obtain an iterator to the last Function in a Module. 702 * 703 * @see llvm::Module::end() 704 */ 705 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M); 706 707 /** 708 * Advance a Function iterator to the next Function. 709 * 710 * Returns NULL if the iterator was already at the end and there are no more 711 * functions. 712 */ 713 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn); 714 715 /** 716 * Decrement a Function iterator to the previous Function. 717 * 718 * Returns NULL if the iterator was already at the beginning and there are 719 * no previous functions. 720 */ 721 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn); 722 723 /** 724 * @} 725 */ 726 727 /** 728 * @defgroup LLVMCCoreType Types 729 * 730 * Types represent the type of a value. 731 * 732 * Types are associated with a context instance. The context internally 733 * deduplicates types so there is only 1 instance of a specific type 734 * alive at a time. In other words, a unique type is shared among all 735 * consumers within a context. 736 * 737 * A Type in the C API corresponds to llvm::Type. 738 * 739 * Types have the following hierarchy: 740 * 741 * types: 742 * integer type 743 * real type 744 * function type 745 * sequence types: 746 * array type 747 * pointer type 748 * vector type 749 * void type 750 * label type 751 * opaque type 752 * 753 * @{ 754 */ 755 756 /** 757 * Obtain the enumerated type of a Type instance. 758 * 759 * @see llvm::Type:getTypeID() 760 */ 761 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty); 762 763 /** 764 * Whether the type has a known size. 765 * 766 * Things that don't have a size are abstract types, labels, and void.a 767 * 768 * @see llvm::Type::isSized() 769 */ 770 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty); 771 772 /** 773 * Obtain the context to which this type instance is associated. 774 * 775 * @see llvm::Type::getContext() 776 */ 777 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty); 778 779 /** 780 * Dump a representation of a type to stderr. 781 * 782 * @see llvm::Type::dump() 783 */ 784 void LLVMDumpType(LLVMTypeRef Val); 785 786 /** 787 * Return a string representation of the type. Use 788 * LLVMDisposeMessage to free the string. 789 * 790 * @see llvm::Type::print() 791 */ 792 char *LLVMPrintTypeToString(LLVMTypeRef Val); 793 794 /** 795 * @defgroup LLVMCCoreTypeInt Integer Types 796 * 797 * Functions in this section operate on integer types. 798 * 799 * @{ 800 */ 801 802 /** 803 * Obtain an integer type from a context with specified bit width. 804 */ 805 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C); 806 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C); 807 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C); 808 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C); 809 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C); 810 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits); 811 812 /** 813 * Obtain an integer type from the global context with a specified bit 814 * width. 815 */ 816 LLVMTypeRef LLVMInt1Type(void); 817 LLVMTypeRef LLVMInt8Type(void); 818 LLVMTypeRef LLVMInt16Type(void); 819 LLVMTypeRef LLVMInt32Type(void); 820 LLVMTypeRef LLVMInt64Type(void); 821 LLVMTypeRef LLVMIntType(unsigned NumBits); 822 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy); 823 824 /** 825 * @} 826 */ 827 828 /** 829 * @defgroup LLVMCCoreTypeFloat Floating Point Types 830 * 831 * @{ 832 */ 833 834 /** 835 * Obtain a 16-bit floating point type from a context. 836 */ 837 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C); 838 839 /** 840 * Obtain a 32-bit floating point type from a context. 841 */ 842 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C); 843 844 /** 845 * Obtain a 64-bit floating point type from a context. 846 */ 847 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C); 848 849 /** 850 * Obtain a 80-bit floating point type (X87) from a context. 851 */ 852 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C); 853 854 /** 855 * Obtain a 128-bit floating point type (112-bit mantissa) from a 856 * context. 857 */ 858 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C); 859 860 /** 861 * Obtain a 128-bit floating point type (two 64-bits) from a context. 862 */ 863 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C); 864 865 /** 866 * Obtain a floating point type from the global context. 867 * 868 * These map to the functions in this group of the same name. 869 */ 870 LLVMTypeRef LLVMHalfType(void); 871 LLVMTypeRef LLVMFloatType(void); 872 LLVMTypeRef LLVMDoubleType(void); 873 LLVMTypeRef LLVMX86FP80Type(void); 874 LLVMTypeRef LLVMFP128Type(void); 875 LLVMTypeRef LLVMPPCFP128Type(void); 876 877 /** 878 * @} 879 */ 880 881 /** 882 * @defgroup LLVMCCoreTypeFunction Function Types 883 * 884 * @{ 885 */ 886 887 /** 888 * Obtain a function type consisting of a specified signature. 889 * 890 * The function is defined as a tuple of a return Type, a list of 891 * parameter types, and whether the function is variadic. 892 */ 893 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType, 894 LLVMTypeRef *ParamTypes, unsigned ParamCount, 895 LLVMBool IsVarArg); 896 897 /** 898 * Returns whether a function type is variadic. 899 */ 900 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy); 901 902 /** 903 * Obtain the Type this function Type returns. 904 */ 905 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy); 906 907 /** 908 * Obtain the number of parameters this function accepts. 909 */ 910 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy); 911 912 /** 913 * Obtain the types of a function's parameters. 914 * 915 * The Dest parameter should point to a pre-allocated array of 916 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the 917 * first LLVMCountParamTypes() entries in the array will be populated 918 * with LLVMTypeRef instances. 919 * 920 * @param FunctionTy The function type to operate on. 921 * @param Dest Memory address of an array to be filled with result. 922 */ 923 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest); 924 925 /** 926 * @} 927 */ 928 929 /** 930 * @defgroup LLVMCCoreTypeStruct Structure Types 931 * 932 * These functions relate to LLVMTypeRef instances. 933 * 934 * @see llvm::StructType 935 * 936 * @{ 937 */ 938 939 /** 940 * Create a new structure type in a context. 941 * 942 * A structure is specified by a list of inner elements/types and 943 * whether these can be packed together. 944 * 945 * @see llvm::StructType::create() 946 */ 947 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes, 948 unsigned ElementCount, LLVMBool Packed); 949 950 /** 951 * Create a new structure type in the global context. 952 * 953 * @see llvm::StructType::create() 954 */ 955 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount, 956 LLVMBool Packed); 957 958 /** 959 * Create an empty structure in a context having a specified name. 960 * 961 * @see llvm::StructType::create() 962 */ 963 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name); 964 965 /** 966 * Obtain the name of a structure. 967 * 968 * @see llvm::StructType::getName() 969 */ 970 const char *LLVMGetStructName(LLVMTypeRef Ty); 971 972 /** 973 * Set the contents of a structure type. 974 * 975 * @see llvm::StructType::setBody() 976 */ 977 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes, 978 unsigned ElementCount, LLVMBool Packed); 979 980 /** 981 * Get the number of elements defined inside the structure. 982 * 983 * @see llvm::StructType::getNumElements() 984 */ 985 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy); 986 987 /** 988 * Get the elements within a structure. 989 * 990 * The function is passed the address of a pre-allocated array of 991 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After 992 * invocation, this array will be populated with the structure's 993 * elements. The objects in the destination array will have a lifetime 994 * of the structure type itself, which is the lifetime of the context it 995 * is contained in. 996 */ 997 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest); 998 999 /** 1000 * Determine whether a structure is packed. 1001 * 1002 * @see llvm::StructType::isPacked() 1003 */ 1004 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy); 1005 1006 /** 1007 * Determine whether a structure is opaque. 1008 * 1009 * @see llvm::StructType::isOpaque() 1010 */ 1011 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy); 1012 1013 /** 1014 * @} 1015 */ 1016 1017 1018 /** 1019 * @defgroup LLVMCCoreTypeSequential Sequential Types 1020 * 1021 * Sequential types represents "arrays" of types. This is a super class 1022 * for array, vector, and pointer types. 1023 * 1024 * @{ 1025 */ 1026 1027 /** 1028 * Obtain the type of elements within a sequential type. 1029 * 1030 * This works on array, vector, and pointer types. 1031 * 1032 * @see llvm::SequentialType::getElementType() 1033 */ 1034 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty); 1035 1036 /** 1037 * Create a fixed size array type that refers to a specific type. 1038 * 1039 * The created type will exist in the context that its element type 1040 * exists in. 1041 * 1042 * @see llvm::ArrayType::get() 1043 */ 1044 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount); 1045 1046 /** 1047 * Obtain the length of an array type. 1048 * 1049 * This only works on types that represent arrays. 1050 * 1051 * @see llvm::ArrayType::getNumElements() 1052 */ 1053 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy); 1054 1055 /** 1056 * Create a pointer type that points to a defined type. 1057 * 1058 * The created type will exist in the context that its pointee type 1059 * exists in. 1060 * 1061 * @see llvm::PointerType::get() 1062 */ 1063 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace); 1064 1065 /** 1066 * Obtain the address space of a pointer type. 1067 * 1068 * This only works on types that represent pointers. 1069 * 1070 * @see llvm::PointerType::getAddressSpace() 1071 */ 1072 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy); 1073 1074 /** 1075 * Create a vector type that contains a defined type and has a specific 1076 * number of elements. 1077 * 1078 * The created type will exist in the context thats its element type 1079 * exists in. 1080 * 1081 * @see llvm::VectorType::get() 1082 */ 1083 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount); 1084 1085 /** 1086 * Obtain the number of elements in a vector type. 1087 * 1088 * This only works on types that represent vectors. 1089 * 1090 * @see llvm::VectorType::getNumElements() 1091 */ 1092 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy); 1093 1094 /** 1095 * @} 1096 */ 1097 1098 /** 1099 * @defgroup LLVMCCoreTypeOther Other Types 1100 * 1101 * @{ 1102 */ 1103 1104 /** 1105 * Create a void type in a context. 1106 */ 1107 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C); 1108 1109 /** 1110 * Create a label type in a context. 1111 */ 1112 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C); 1113 1114 /** 1115 * Create a X86 MMX type in a context. 1116 */ 1117 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C); 1118 1119 /** 1120 * These are similar to the above functions except they operate on the 1121 * global context. 1122 */ 1123 LLVMTypeRef LLVMVoidType(void); 1124 LLVMTypeRef LLVMLabelType(void); 1125 LLVMTypeRef LLVMX86MMXType(void); 1126 1127 /** 1128 * @} 1129 */ 1130 1131 /** 1132 * @} 1133 */ 1134 1135 /** 1136 * @defgroup LLVMCCoreValues Values 1137 * 1138 * The bulk of LLVM's object model consists of values, which comprise a very 1139 * rich type hierarchy. 1140 * 1141 * LLVMValueRef essentially represents llvm::Value. There is a rich 1142 * hierarchy of classes within this type. Depending on the instance 1143 * obtained, not all APIs are available. 1144 * 1145 * Callers can determine the type of an LLVMValueRef by calling the 1146 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These 1147 * functions are defined by a macro, so it isn't obvious which are 1148 * available by looking at the Doxygen source code. Instead, look at the 1149 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list 1150 * of value names given. These value names also correspond to classes in 1151 * the llvm::Value hierarchy. 1152 * 1153 * @{ 1154 */ 1155 1156 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \ 1157 macro(Argument) \ 1158 macro(BasicBlock) \ 1159 macro(InlineAsm) \ 1160 macro(User) \ 1161 macro(Constant) \ 1162 macro(BlockAddress) \ 1163 macro(ConstantAggregateZero) \ 1164 macro(ConstantArray) \ 1165 macro(ConstantDataSequential) \ 1166 macro(ConstantDataArray) \ 1167 macro(ConstantDataVector) \ 1168 macro(ConstantExpr) \ 1169 macro(ConstantFP) \ 1170 macro(ConstantInt) \ 1171 macro(ConstantPointerNull) \ 1172 macro(ConstantStruct) \ 1173 macro(ConstantVector) \ 1174 macro(GlobalValue) \ 1175 macro(GlobalAlias) \ 1176 macro(GlobalObject) \ 1177 macro(Function) \ 1178 macro(GlobalVariable) \ 1179 macro(UndefValue) \ 1180 macro(Instruction) \ 1181 macro(BinaryOperator) \ 1182 macro(CallInst) \ 1183 macro(IntrinsicInst) \ 1184 macro(DbgInfoIntrinsic) \ 1185 macro(DbgDeclareInst) \ 1186 macro(MemIntrinsic) \ 1187 macro(MemCpyInst) \ 1188 macro(MemMoveInst) \ 1189 macro(MemSetInst) \ 1190 macro(CmpInst) \ 1191 macro(FCmpInst) \ 1192 macro(ICmpInst) \ 1193 macro(ExtractElementInst) \ 1194 macro(GetElementPtrInst) \ 1195 macro(InsertElementInst) \ 1196 macro(InsertValueInst) \ 1197 macro(LandingPadInst) \ 1198 macro(PHINode) \ 1199 macro(SelectInst) \ 1200 macro(ShuffleVectorInst) \ 1201 macro(StoreInst) \ 1202 macro(TerminatorInst) \ 1203 macro(BranchInst) \ 1204 macro(IndirectBrInst) \ 1205 macro(InvokeInst) \ 1206 macro(ReturnInst) \ 1207 macro(SwitchInst) \ 1208 macro(UnreachableInst) \ 1209 macro(ResumeInst) \ 1210 macro(UnaryInstruction) \ 1211 macro(AllocaInst) \ 1212 macro(CastInst) \ 1213 macro(AddrSpaceCastInst) \ 1214 macro(BitCastInst) \ 1215 macro(FPExtInst) \ 1216 macro(FPToSIInst) \ 1217 macro(FPToUIInst) \ 1218 macro(FPTruncInst) \ 1219 macro(IntToPtrInst) \ 1220 macro(PtrToIntInst) \ 1221 macro(SExtInst) \ 1222 macro(SIToFPInst) \ 1223 macro(TruncInst) \ 1224 macro(UIToFPInst) \ 1225 macro(ZExtInst) \ 1226 macro(ExtractValueInst) \ 1227 macro(LoadInst) \ 1228 macro(VAArgInst) 1229 1230 /** 1231 * @defgroup LLVMCCoreValueGeneral General APIs 1232 * 1233 * Functions in this section work on all LLVMValueRef instances, 1234 * regardless of their sub-type. They correspond to functions available 1235 * on llvm::Value. 1236 * 1237 * @{ 1238 */ 1239 1240 /** 1241 * Obtain the type of a value. 1242 * 1243 * @see llvm::Value::getType() 1244 */ 1245 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val); 1246 1247 /** 1248 * Obtain the string name of a value. 1249 * 1250 * @see llvm::Value::getName() 1251 */ 1252 const char *LLVMGetValueName(LLVMValueRef Val); 1253 1254 /** 1255 * Set the string name of a value. 1256 * 1257 * @see llvm::Value::setName() 1258 */ 1259 void LLVMSetValueName(LLVMValueRef Val, const char *Name); 1260 1261 /** 1262 * Dump a representation of a value to stderr. 1263 * 1264 * @see llvm::Value::dump() 1265 */ 1266 void LLVMDumpValue(LLVMValueRef Val); 1267 1268 /** 1269 * Return a string representation of the value. Use 1270 * LLVMDisposeMessage to free the string. 1271 * 1272 * @see llvm::Value::print() 1273 */ 1274 char *LLVMPrintValueToString(LLVMValueRef Val); 1275 1276 /** 1277 * Replace all uses of a value with another one. 1278 * 1279 * @see llvm::Value::replaceAllUsesWith() 1280 */ 1281 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal); 1282 1283 /** 1284 * Determine whether the specified constant instance is constant. 1285 */ 1286 LLVMBool LLVMIsConstant(LLVMValueRef Val); 1287 1288 /** 1289 * Determine whether a value instance is undefined. 1290 */ 1291 LLVMBool LLVMIsUndef(LLVMValueRef Val); 1292 1293 /** 1294 * Convert value instances between types. 1295 * 1296 * Internally, an LLVMValueRef is "pinned" to a specific type. This 1297 * series of functions allows you to cast an instance to a specific 1298 * type. 1299 * 1300 * If the cast is not valid for the specified type, NULL is returned. 1301 * 1302 * @see llvm::dyn_cast_or_null<> 1303 */ 1304 #define LLVM_DECLARE_VALUE_CAST(name) \ 1305 LLVMValueRef LLVMIsA##name(LLVMValueRef Val); 1306 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST) 1307 1308 LLVMValueRef LLVMIsAMDNode(LLVMValueRef Val); 1309 LLVMValueRef LLVMIsAMDString(LLVMValueRef Val); 1310 1311 /** 1312 * @} 1313 */ 1314 1315 /** 1316 * @defgroup LLVMCCoreValueUses Usage 1317 * 1318 * This module defines functions that allow you to inspect the uses of a 1319 * LLVMValueRef. 1320 * 1321 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance. 1322 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a 1323 * llvm::User and llvm::Value. 1324 * 1325 * @{ 1326 */ 1327 1328 /** 1329 * Obtain the first use of a value. 1330 * 1331 * Uses are obtained in an iterator fashion. First, call this function 1332 * to obtain a reference to the first use. Then, call LLVMGetNextUse() 1333 * on that instance and all subsequently obtained instances until 1334 * LLVMGetNextUse() returns NULL. 1335 * 1336 * @see llvm::Value::use_begin() 1337 */ 1338 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val); 1339 1340 /** 1341 * Obtain the next use of a value. 1342 * 1343 * This effectively advances the iterator. It returns NULL if you are on 1344 * the final use and no more are available. 1345 */ 1346 LLVMUseRef LLVMGetNextUse(LLVMUseRef U); 1347 1348 /** 1349 * Obtain the user value for a user. 1350 * 1351 * The returned value corresponds to a llvm::User type. 1352 * 1353 * @see llvm::Use::getUser() 1354 */ 1355 LLVMValueRef LLVMGetUser(LLVMUseRef U); 1356 1357 /** 1358 * Obtain the value this use corresponds to. 1359 * 1360 * @see llvm::Use::get(). 1361 */ 1362 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U); 1363 1364 /** 1365 * @} 1366 */ 1367 1368 /** 1369 * @defgroup LLVMCCoreValueUser User value 1370 * 1371 * Function in this group pertain to LLVMValueRef instances that descent 1372 * from llvm::User. This includes constants, instructions, and 1373 * operators. 1374 * 1375 * @{ 1376 */ 1377 1378 /** 1379 * Obtain an operand at a specific index in a llvm::User value. 1380 * 1381 * @see llvm::User::getOperand() 1382 */ 1383 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index); 1384 1385 /** 1386 * Obtain the use of an operand at a specific index in a llvm::User value. 1387 * 1388 * @see llvm::User::getOperandUse() 1389 */ 1390 LLVMUseRef LLVMGetOperandUse(LLVMValueRef Val, unsigned Index); 1391 1392 /** 1393 * Set an operand at a specific index in a llvm::User value. 1394 * 1395 * @see llvm::User::setOperand() 1396 */ 1397 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val); 1398 1399 /** 1400 * Obtain the number of operands in a llvm::User value. 1401 * 1402 * @see llvm::User::getNumOperands() 1403 */ 1404 int LLVMGetNumOperands(LLVMValueRef Val); 1405 1406 /** 1407 * @} 1408 */ 1409 1410 /** 1411 * @defgroup LLVMCCoreValueConstant Constants 1412 * 1413 * This section contains APIs for interacting with LLVMValueRef that 1414 * correspond to llvm::Constant instances. 1415 * 1416 * These functions will work for any LLVMValueRef in the llvm::Constant 1417 * class hierarchy. 1418 * 1419 * @{ 1420 */ 1421 1422 /** 1423 * Obtain a constant value referring to the null instance of a type. 1424 * 1425 * @see llvm::Constant::getNullValue() 1426 */ 1427 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */ 1428 1429 /** 1430 * Obtain a constant value referring to the instance of a type 1431 * consisting of all ones. 1432 * 1433 * This is only valid for integer types. 1434 * 1435 * @see llvm::Constant::getAllOnesValue() 1436 */ 1437 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); 1438 1439 /** 1440 * Obtain a constant value referring to an undefined value of a type. 1441 * 1442 * @see llvm::UndefValue::get() 1443 */ 1444 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty); 1445 1446 /** 1447 * Determine whether a value instance is null. 1448 * 1449 * @see llvm::Constant::isNullValue() 1450 */ 1451 LLVMBool LLVMIsNull(LLVMValueRef Val); 1452 1453 /** 1454 * Obtain a constant that is a constant pointer pointing to NULL for a 1455 * specified type. 1456 */ 1457 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty); 1458 1459 /** 1460 * @defgroup LLVMCCoreValueConstantScalar Scalar constants 1461 * 1462 * Functions in this group model LLVMValueRef instances that correspond 1463 * to constants referring to scalar types. 1464 * 1465 * For integer types, the LLVMTypeRef parameter should correspond to a 1466 * llvm::IntegerType instance and the returned LLVMValueRef will 1467 * correspond to a llvm::ConstantInt. 1468 * 1469 * For floating point types, the LLVMTypeRef returned corresponds to a 1470 * llvm::ConstantFP. 1471 * 1472 * @{ 1473 */ 1474 1475 /** 1476 * Obtain a constant value for an integer type. 1477 * 1478 * The returned value corresponds to a llvm::ConstantInt. 1479 * 1480 * @see llvm::ConstantInt::get() 1481 * 1482 * @param IntTy Integer type to obtain value of. 1483 * @param N The value the returned instance should refer to. 1484 * @param SignExtend Whether to sign extend the produced value. 1485 */ 1486 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N, 1487 LLVMBool SignExtend); 1488 1489 /** 1490 * Obtain a constant value for an integer of arbitrary precision. 1491 * 1492 * @see llvm::ConstantInt::get() 1493 */ 1494 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy, 1495 unsigned NumWords, 1496 const uint64_t Words[]); 1497 1498 /** 1499 * Obtain a constant value for an integer parsed from a string. 1500 * 1501 * A similar API, LLVMConstIntOfStringAndSize is also available. If the 1502 * string's length is available, it is preferred to call that function 1503 * instead. 1504 * 1505 * @see llvm::ConstantInt::get() 1506 */ 1507 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text, 1508 uint8_t Radix); 1509 1510 /** 1511 * Obtain a constant value for an integer parsed from a string with 1512 * specified length. 1513 * 1514 * @see llvm::ConstantInt::get() 1515 */ 1516 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text, 1517 unsigned SLen, uint8_t Radix); 1518 1519 /** 1520 * Obtain a constant value referring to a double floating point value. 1521 */ 1522 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N); 1523 1524 /** 1525 * Obtain a constant for a floating point value parsed from a string. 1526 * 1527 * A similar API, LLVMConstRealOfStringAndSize is also available. It 1528 * should be used if the input string's length is known. 1529 */ 1530 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text); 1531 1532 /** 1533 * Obtain a constant for a floating point value parsed from a string. 1534 */ 1535 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text, 1536 unsigned SLen); 1537 1538 /** 1539 * Obtain the zero extended value for an integer constant value. 1540 * 1541 * @see llvm::ConstantInt::getZExtValue() 1542 */ 1543 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal); 1544 1545 /** 1546 * Obtain the sign extended value for an integer constant value. 1547 * 1548 * @see llvm::ConstantInt::getSExtValue() 1549 */ 1550 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal); 1551 1552 /** 1553 * Obtain the double value for an floating point constant value. 1554 * losesInfo indicates if some precision was lost in the conversion. 1555 * 1556 * @see llvm::ConstantFP::getDoubleValue 1557 */ 1558 double LLVMConstRealGetDouble(LLVMValueRef ConstantVal, LLVMBool *losesInfo); 1559 1560 /** 1561 * @} 1562 */ 1563 1564 /** 1565 * @defgroup LLVMCCoreValueConstantComposite Composite Constants 1566 * 1567 * Functions in this group operate on composite constants. 1568 * 1569 * @{ 1570 */ 1571 1572 /** 1573 * Create a ConstantDataSequential and initialize it with a string. 1574 * 1575 * @see llvm::ConstantDataArray::getString() 1576 */ 1577 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str, 1578 unsigned Length, LLVMBool DontNullTerminate); 1579 1580 /** 1581 * Create a ConstantDataSequential with string content in the global context. 1582 * 1583 * This is the same as LLVMConstStringInContext except it operates on the 1584 * global context. 1585 * 1586 * @see LLVMConstStringInContext() 1587 * @see llvm::ConstantDataArray::getString() 1588 */ 1589 LLVMValueRef LLVMConstString(const char *Str, unsigned Length, 1590 LLVMBool DontNullTerminate); 1591 1592 /** 1593 * Returns true if the specified constant is an array of i8. 1594 * 1595 * @see ConstantDataSequential::getAsString() 1596 */ 1597 LLVMBool LLVMIsConstantString(LLVMValueRef c); 1598 1599 /** 1600 * Get the given constant data sequential as a string. 1601 * 1602 * @see ConstantDataSequential::getAsString() 1603 */ 1604 const char *LLVMGetAsString(LLVMValueRef c, size_t* out); 1605 1606 /** 1607 * Create an anonymous ConstantStruct with the specified values. 1608 * 1609 * @see llvm::ConstantStruct::getAnon() 1610 */ 1611 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C, 1612 LLVMValueRef *ConstantVals, 1613 unsigned Count, LLVMBool Packed); 1614 1615 /** 1616 * Create a ConstantStruct in the global Context. 1617 * 1618 * This is the same as LLVMConstStructInContext except it operates on the 1619 * global Context. 1620 * 1621 * @see LLVMConstStructInContext() 1622 */ 1623 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count, 1624 LLVMBool Packed); 1625 1626 /** 1627 * Create a ConstantArray from values. 1628 * 1629 * @see llvm::ConstantArray::get() 1630 */ 1631 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy, 1632 LLVMValueRef *ConstantVals, unsigned Length); 1633 1634 /** 1635 * Create a non-anonymous ConstantStruct from values. 1636 * 1637 * @see llvm::ConstantStruct::get() 1638 */ 1639 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy, 1640 LLVMValueRef *ConstantVals, 1641 unsigned Count); 1642 1643 /** 1644 * Get an element at specified index as a constant. 1645 * 1646 * @see ConstantDataSequential::getElementAsConstant() 1647 */ 1648 LLVMValueRef LLVMGetElementAsConstant(LLVMValueRef c, unsigned idx); 1649 1650 /** 1651 * Create a ConstantVector from values. 1652 * 1653 * @see llvm::ConstantVector::get() 1654 */ 1655 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size); 1656 1657 /** 1658 * @} 1659 */ 1660 1661 /** 1662 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions 1663 * 1664 * Functions in this group correspond to APIs on llvm::ConstantExpr. 1665 * 1666 * @see llvm::ConstantExpr. 1667 * 1668 * @{ 1669 */ 1670 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal); 1671 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty); 1672 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty); 1673 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal); 1674 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal); 1675 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal); 1676 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal); 1677 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal); 1678 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1679 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1680 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1681 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1682 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1683 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1684 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1685 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1686 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1687 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1688 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1689 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1690 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1691 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1692 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1693 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1694 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1695 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1696 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1697 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1698 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1699 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1700 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate, 1701 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1702 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate, 1703 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1704 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1705 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1706 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1707 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal, 1708 LLVMValueRef *ConstantIndices, unsigned NumIndices); 1709 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal, 1710 LLVMValueRef *ConstantIndices, 1711 unsigned NumIndices); 1712 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1713 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1714 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1715 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1716 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1717 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1718 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1719 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1720 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1721 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1722 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1723 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1724 LLVMValueRef LLVMConstAddrSpaceCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1725 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal, 1726 LLVMTypeRef ToType); 1727 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal, 1728 LLVMTypeRef ToType); 1729 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal, 1730 LLVMTypeRef ToType); 1731 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal, 1732 LLVMTypeRef ToType); 1733 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType, 1734 LLVMBool isSigned); 1735 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1736 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition, 1737 LLVMValueRef ConstantIfTrue, 1738 LLVMValueRef ConstantIfFalse); 1739 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant, 1740 LLVMValueRef IndexConstant); 1741 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant, 1742 LLVMValueRef ElementValueConstant, 1743 LLVMValueRef IndexConstant); 1744 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant, 1745 LLVMValueRef VectorBConstant, 1746 LLVMValueRef MaskConstant); 1747 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList, 1748 unsigned NumIdx); 1749 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant, 1750 LLVMValueRef ElementValueConstant, 1751 unsigned *IdxList, unsigned NumIdx); 1752 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty, 1753 const char *AsmString, const char *Constraints, 1754 LLVMBool HasSideEffects, LLVMBool IsAlignStack); 1755 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB); 1756 1757 /** 1758 * @} 1759 */ 1760 1761 /** 1762 * @defgroup LLVMCCoreValueConstantGlobals Global Values 1763 * 1764 * This group contains functions that operate on global values. Functions in 1765 * this group relate to functions in the llvm::GlobalValue class tree. 1766 * 1767 * @see llvm::GlobalValue 1768 * 1769 * @{ 1770 */ 1771 1772 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global); 1773 LLVMBool LLVMIsDeclaration(LLVMValueRef Global); 1774 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global); 1775 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage); 1776 const char *LLVMGetSection(LLVMValueRef Global); 1777 void LLVMSetSection(LLVMValueRef Global, const char *Section); 1778 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global); 1779 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz); 1780 LLVMDLLStorageClass LLVMGetDLLStorageClass(LLVMValueRef Global); 1781 void LLVMSetDLLStorageClass(LLVMValueRef Global, LLVMDLLStorageClass Class); 1782 LLVMBool LLVMHasUnnamedAddr(LLVMValueRef Global); 1783 void LLVMSetUnnamedAddr(LLVMValueRef Global, LLVMBool HasUnnamedAddr); 1784 1785 /** 1786 * @defgroup LLVMCCoreValueWithAlignment Values with alignment 1787 * 1788 * Functions in this group only apply to values with alignment, i.e. 1789 * global variables, load and store instructions. 1790 */ 1791 1792 /** 1793 * Obtain the preferred alignment of the value. 1794 * @see llvm::AllocaInst::getAlignment() 1795 * @see llvm::LoadInst::getAlignment() 1796 * @see llvm::StoreInst::getAlignment() 1797 * @see llvm::GlobalValue::getAlignment() 1798 */ 1799 unsigned LLVMGetAlignment(LLVMValueRef V); 1800 1801 /** 1802 * Set the preferred alignment of the value. 1803 * @see llvm::AllocaInst::setAlignment() 1804 * @see llvm::LoadInst::setAlignment() 1805 * @see llvm::StoreInst::setAlignment() 1806 * @see llvm::GlobalValue::setAlignment() 1807 */ 1808 void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes); 1809 1810 /** 1811 * @} 1812 */ 1813 1814 /** 1815 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables 1816 * 1817 * This group contains functions that operate on global variable values. 1818 * 1819 * @see llvm::GlobalVariable 1820 * 1821 * @{ 1822 */ 1823 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name); 1824 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty, 1825 const char *Name, 1826 unsigned AddressSpace); 1827 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name); 1828 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M); 1829 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M); 1830 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar); 1831 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar); 1832 void LLVMDeleteGlobal(LLVMValueRef GlobalVar); 1833 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar); 1834 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal); 1835 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar); 1836 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal); 1837 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar); 1838 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant); 1839 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar); 1840 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode); 1841 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar); 1842 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit); 1843 1844 /** 1845 * @} 1846 */ 1847 1848 /** 1849 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases 1850 * 1851 * This group contains function that operate on global alias values. 1852 * 1853 * @see llvm::GlobalAlias 1854 * 1855 * @{ 1856 */ 1857 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee, 1858 const char *Name); 1859 1860 /** 1861 * @} 1862 */ 1863 1864 /** 1865 * @defgroup LLVMCCoreValueFunction Function values 1866 * 1867 * Functions in this group operate on LLVMValueRef instances that 1868 * correspond to llvm::Function instances. 1869 * 1870 * @see llvm::Function 1871 * 1872 * @{ 1873 */ 1874 1875 /** 1876 * Remove a function from its containing module and deletes it. 1877 * 1878 * @see llvm::Function::eraseFromParent() 1879 */ 1880 void LLVMDeleteFunction(LLVMValueRef Fn); 1881 1882 /** 1883 * Obtain the ID number from a function instance. 1884 * 1885 * @see llvm::Function::getIntrinsicID() 1886 */ 1887 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn); 1888 1889 /** 1890 * Obtain the calling function of a function. 1891 * 1892 * The returned value corresponds to the LLVMCallConv enumeration. 1893 * 1894 * @see llvm::Function::getCallingConv() 1895 */ 1896 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn); 1897 1898 /** 1899 * Set the calling convention of a function. 1900 * 1901 * @see llvm::Function::setCallingConv() 1902 * 1903 * @param Fn Function to operate on 1904 * @param CC LLVMCallConv to set calling convention to 1905 */ 1906 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC); 1907 1908 /** 1909 * Obtain the name of the garbage collector to use during code 1910 * generation. 1911 * 1912 * @see llvm::Function::getGC() 1913 */ 1914 const char *LLVMGetGC(LLVMValueRef Fn); 1915 1916 /** 1917 * Define the garbage collector to use during code generation. 1918 * 1919 * @see llvm::Function::setGC() 1920 */ 1921 void LLVMSetGC(LLVMValueRef Fn, const char *Name); 1922 1923 /** 1924 * Add an attribute to a function. 1925 * 1926 * @see llvm::Function::addAttribute() 1927 */ 1928 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA); 1929 1930 /** 1931 * Add a target-dependent attribute to a fuction 1932 * @see llvm::AttrBuilder::addAttribute() 1933 */ 1934 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A, 1935 const char *V); 1936 1937 /** 1938 * Obtain an attribute from a function. 1939 * 1940 * @see llvm::Function::getAttributes() 1941 */ 1942 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn); 1943 1944 /** 1945 * Remove an attribute from a function. 1946 */ 1947 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA); 1948 1949 /** 1950 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters 1951 * 1952 * Functions in this group relate to arguments/parameters on functions. 1953 * 1954 * Functions in this group expect LLVMValueRef instances that correspond 1955 * to llvm::Function instances. 1956 * 1957 * @{ 1958 */ 1959 1960 /** 1961 * Obtain the number of parameters in a function. 1962 * 1963 * @see llvm::Function::arg_size() 1964 */ 1965 unsigned LLVMCountParams(LLVMValueRef Fn); 1966 1967 /** 1968 * Obtain the parameters in a function. 1969 * 1970 * The takes a pointer to a pre-allocated array of LLVMValueRef that is 1971 * at least LLVMCountParams() long. This array will be filled with 1972 * LLVMValueRef instances which correspond to the parameters the 1973 * function receives. Each LLVMValueRef corresponds to a llvm::Argument 1974 * instance. 1975 * 1976 * @see llvm::Function::arg_begin() 1977 */ 1978 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params); 1979 1980 /** 1981 * Obtain the parameter at the specified index. 1982 * 1983 * Parameters are indexed from 0. 1984 * 1985 * @see llvm::Function::arg_begin() 1986 */ 1987 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index); 1988 1989 /** 1990 * Obtain the function to which this argument belongs. 1991 * 1992 * Unlike other functions in this group, this one takes an LLVMValueRef 1993 * that corresponds to a llvm::Attribute. 1994 * 1995 * The returned LLVMValueRef is the llvm::Function to which this 1996 * argument belongs. 1997 */ 1998 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst); 1999 2000 /** 2001 * Obtain the first parameter to a function. 2002 * 2003 * @see llvm::Function::arg_begin() 2004 */ 2005 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn); 2006 2007 /** 2008 * Obtain the last parameter to a function. 2009 * 2010 * @see llvm::Function::arg_end() 2011 */ 2012 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn); 2013 2014 /** 2015 * Obtain the next parameter to a function. 2016 * 2017 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is 2018 * actually a wrapped iterator) and obtains the next parameter from the 2019 * underlying iterator. 2020 */ 2021 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg); 2022 2023 /** 2024 * Obtain the previous parameter to a function. 2025 * 2026 * This is the opposite of LLVMGetNextParam(). 2027 */ 2028 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg); 2029 2030 /** 2031 * Add an attribute to a function argument. 2032 * 2033 * @see llvm::Argument::addAttr() 2034 */ 2035 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA); 2036 2037 /** 2038 * Remove an attribute from a function argument. 2039 * 2040 * @see llvm::Argument::removeAttr() 2041 */ 2042 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA); 2043 2044 /** 2045 * Get an attribute from a function argument. 2046 */ 2047 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg); 2048 2049 /** 2050 * Set the alignment for a function parameter. 2051 * 2052 * @see llvm::Argument::addAttr() 2053 * @see llvm::AttrBuilder::addAlignmentAttr() 2054 */ 2055 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align); 2056 2057 /** 2058 * @} 2059 */ 2060 2061 /** 2062 * @} 2063 */ 2064 2065 /** 2066 * @} 2067 */ 2068 2069 /** 2070 * @} 2071 */ 2072 2073 /** 2074 * @defgroup LLVMCCoreValueMetadata Metadata 2075 * 2076 * @{ 2077 */ 2078 2079 /** 2080 * Obtain a MDString value from a context. 2081 * 2082 * The returned instance corresponds to the llvm::MDString class. 2083 * 2084 * The instance is specified by string data of a specified length. The 2085 * string content is copied, so the backing memory can be freed after 2086 * this function returns. 2087 */ 2088 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str, 2089 unsigned SLen); 2090 2091 /** 2092 * Obtain a MDString value from the global context. 2093 */ 2094 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen); 2095 2096 /** 2097 * Obtain a MDNode value from a context. 2098 * 2099 * The returned value corresponds to the llvm::MDNode class. 2100 */ 2101 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals, 2102 unsigned Count); 2103 2104 /** 2105 * Obtain a MDNode value from the global context. 2106 */ 2107 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count); 2108 2109 /** 2110 * Obtain the underlying string from a MDString value. 2111 * 2112 * @param V Instance to obtain string from. 2113 * @param Len Memory address which will hold length of returned string. 2114 * @return String data in MDString. 2115 */ 2116 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len); 2117 2118 /** 2119 * Obtain the number of operands from an MDNode value. 2120 * 2121 * @param V MDNode to get number of operands from. 2122 * @return Number of operands of the MDNode. 2123 */ 2124 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V); 2125 2126 /** 2127 * Obtain the given MDNode's operands. 2128 * 2129 * The passed LLVMValueRef pointer should point to enough memory to hold all of 2130 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as 2131 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the 2132 * MDNode's operands. 2133 * 2134 * @param V MDNode to get the operands from. 2135 * @param Dest Destination array for operands. 2136 */ 2137 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest); 2138 2139 /** 2140 * @} 2141 */ 2142 2143 /** 2144 * @defgroup LLVMCCoreValueBasicBlock Basic Block 2145 * 2146 * A basic block represents a single entry single exit section of code. 2147 * Basic blocks contain a list of instructions which form the body of 2148 * the block. 2149 * 2150 * Basic blocks belong to functions. They have the type of label. 2151 * 2152 * Basic blocks are themselves values. However, the C API models them as 2153 * LLVMBasicBlockRef. 2154 * 2155 * @see llvm::BasicBlock 2156 * 2157 * @{ 2158 */ 2159 2160 /** 2161 * Convert a basic block instance to a value type. 2162 */ 2163 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB); 2164 2165 /** 2166 * Determine whether an LLVMValueRef is itself a basic block. 2167 */ 2168 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val); 2169 2170 /** 2171 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance. 2172 */ 2173 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val); 2174 2175 /** 2176 * Obtain the function to which a basic block belongs. 2177 * 2178 * @see llvm::BasicBlock::getParent() 2179 */ 2180 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB); 2181 2182 /** 2183 * Obtain the terminator instruction for a basic block. 2184 * 2185 * If the basic block does not have a terminator (it is not well-formed 2186 * if it doesn't), then NULL is returned. 2187 * 2188 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst. 2189 * 2190 * @see llvm::BasicBlock::getTerminator() 2191 */ 2192 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB); 2193 2194 /** 2195 * Obtain the number of basic blocks in a function. 2196 * 2197 * @param Fn Function value to operate on. 2198 */ 2199 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn); 2200 2201 /** 2202 * Obtain all of the basic blocks in a function. 2203 * 2204 * This operates on a function value. The BasicBlocks parameter is a 2205 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least 2206 * LLVMCountBasicBlocks() in length. This array is populated with 2207 * LLVMBasicBlockRef instances. 2208 */ 2209 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks); 2210 2211 /** 2212 * Obtain the first basic block in a function. 2213 * 2214 * The returned basic block can be used as an iterator. You will likely 2215 * eventually call into LLVMGetNextBasicBlock() with it. 2216 * 2217 * @see llvm::Function::begin() 2218 */ 2219 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn); 2220 2221 /** 2222 * Obtain the last basic block in a function. 2223 * 2224 * @see llvm::Function::end() 2225 */ 2226 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn); 2227 2228 /** 2229 * Advance a basic block iterator. 2230 */ 2231 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB); 2232 2233 /** 2234 * Go backwards in a basic block iterator. 2235 */ 2236 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB); 2237 2238 /** 2239 * Obtain the basic block that corresponds to the entry point of a 2240 * function. 2241 * 2242 * @see llvm::Function::getEntryBlock() 2243 */ 2244 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn); 2245 2246 /** 2247 * Append a basic block to the end of a function. 2248 * 2249 * @see llvm::BasicBlock::Create() 2250 */ 2251 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C, 2252 LLVMValueRef Fn, 2253 const char *Name); 2254 2255 /** 2256 * Append a basic block to the end of a function using the global 2257 * context. 2258 * 2259 * @see llvm::BasicBlock::Create() 2260 */ 2261 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name); 2262 2263 /** 2264 * Insert a basic block in a function before another basic block. 2265 * 2266 * The function to add to is determined by the function of the 2267 * passed basic block. 2268 * 2269 * @see llvm::BasicBlock::Create() 2270 */ 2271 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C, 2272 LLVMBasicBlockRef BB, 2273 const char *Name); 2274 2275 /** 2276 * Insert a basic block in a function using the global context. 2277 * 2278 * @see llvm::BasicBlock::Create() 2279 */ 2280 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB, 2281 const char *Name); 2282 2283 /** 2284 * Remove a basic block from a function and delete it. 2285 * 2286 * This deletes the basic block from its containing function and deletes 2287 * the basic block itself. 2288 * 2289 * @see llvm::BasicBlock::eraseFromParent() 2290 */ 2291 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB); 2292 2293 /** 2294 * Remove a basic block from a function. 2295 * 2296 * This deletes the basic block from its containing function but keep 2297 * the basic block alive. 2298 * 2299 * @see llvm::BasicBlock::removeFromParent() 2300 */ 2301 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB); 2302 2303 /** 2304 * Move a basic block to before another one. 2305 * 2306 * @see llvm::BasicBlock::moveBefore() 2307 */ 2308 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos); 2309 2310 /** 2311 * Move a basic block to after another one. 2312 * 2313 * @see llvm::BasicBlock::moveAfter() 2314 */ 2315 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos); 2316 2317 /** 2318 * Obtain the first instruction in a basic block. 2319 * 2320 * The returned LLVMValueRef corresponds to a llvm::Instruction 2321 * instance. 2322 */ 2323 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB); 2324 2325 /** 2326 * Obtain the last instruction in a basic block. 2327 * 2328 * The returned LLVMValueRef corresponds to an LLVM:Instruction. 2329 */ 2330 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB); 2331 2332 /** 2333 * @} 2334 */ 2335 2336 /** 2337 * @defgroup LLVMCCoreValueInstruction Instructions 2338 * 2339 * Functions in this group relate to the inspection and manipulation of 2340 * individual instructions. 2341 * 2342 * In the C++ API, an instruction is modeled by llvm::Instruction. This 2343 * class has a large number of descendents. llvm::Instruction is a 2344 * llvm::Value and in the C API, instructions are modeled by 2345 * LLVMValueRef. 2346 * 2347 * This group also contains sub-groups which operate on specific 2348 * llvm::Instruction types, e.g. llvm::CallInst. 2349 * 2350 * @{ 2351 */ 2352 2353 /** 2354 * Determine whether an instruction has any metadata attached. 2355 */ 2356 int LLVMHasMetadata(LLVMValueRef Val); 2357 2358 /** 2359 * Return metadata associated with an instruction value. 2360 */ 2361 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID); 2362 2363 /** 2364 * Set metadata associated with an instruction value. 2365 */ 2366 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node); 2367 2368 /** 2369 * Obtain the basic block to which an instruction belongs. 2370 * 2371 * @see llvm::Instruction::getParent() 2372 */ 2373 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst); 2374 2375 /** 2376 * Obtain the instruction that occurs after the one specified. 2377 * 2378 * The next instruction will be from the same basic block. 2379 * 2380 * If this is the last instruction in a basic block, NULL will be 2381 * returned. 2382 */ 2383 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst); 2384 2385 /** 2386 * Obtain the instruction that occurred before this one. 2387 * 2388 * If the instruction is the first instruction in a basic block, NULL 2389 * will be returned. 2390 */ 2391 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst); 2392 2393 /** 2394 * Remove and delete an instruction. 2395 * 2396 * The instruction specified is removed from its containing building 2397 * block and then deleted. 2398 * 2399 * @see llvm::Instruction::eraseFromParent() 2400 */ 2401 void LLVMInstructionEraseFromParent(LLVMValueRef Inst); 2402 2403 /** 2404 * Obtain the code opcode for an individual instruction. 2405 * 2406 * @see llvm::Instruction::getOpCode() 2407 */ 2408 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst); 2409 2410 /** 2411 * Obtain the predicate of an instruction. 2412 * 2413 * This is only valid for instructions that correspond to llvm::ICmpInst 2414 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp. 2415 * 2416 * @see llvm::ICmpInst::getPredicate() 2417 */ 2418 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst); 2419 2420 /** 2421 * Obtain the float predicate of an instruction. 2422 * 2423 * This is only valid for instructions that correspond to llvm::FCmpInst 2424 * or llvm::ConstantExpr whose opcode is llvm::Instruction::FCmp. 2425 * 2426 * @see llvm::FCmpInst::getPredicate() 2427 */ 2428 LLVMRealPredicate LLVMGetFCmpPredicate(LLVMValueRef Inst); 2429 2430 /** 2431 * Create a copy of 'this' instruction that is identical in all ways 2432 * except the following: 2433 * * The instruction has no parent 2434 * * The instruction has no name 2435 * 2436 * @see llvm::Instruction::clone() 2437 */ 2438 LLVMValueRef LLVMInstructionClone(LLVMValueRef Inst); 2439 2440 /** 2441 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations 2442 * 2443 * Functions in this group apply to instructions that refer to call 2444 * sites and invocations. These correspond to C++ types in the 2445 * llvm::CallInst class tree. 2446 * 2447 * @{ 2448 */ 2449 2450 /** 2451 * Set the calling convention for a call instruction. 2452 * 2453 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or 2454 * llvm::InvokeInst. 2455 * 2456 * @see llvm::CallInst::setCallingConv() 2457 * @see llvm::InvokeInst::setCallingConv() 2458 */ 2459 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC); 2460 2461 /** 2462 * Obtain the calling convention for a call instruction. 2463 * 2464 * This is the opposite of LLVMSetInstructionCallConv(). Reads its 2465 * usage. 2466 * 2467 * @see LLVMSetInstructionCallConv() 2468 */ 2469 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr); 2470 2471 2472 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute); 2473 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index, 2474 LLVMAttribute); 2475 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index, 2476 unsigned align); 2477 2478 /** 2479 * Obtain whether a call instruction is a tail call. 2480 * 2481 * This only works on llvm::CallInst instructions. 2482 * 2483 * @see llvm::CallInst::isTailCall() 2484 */ 2485 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst); 2486 2487 /** 2488 * Set whether a call instruction is a tail call. 2489 * 2490 * This only works on llvm::CallInst instructions. 2491 * 2492 * @see llvm::CallInst::setTailCall() 2493 */ 2494 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall); 2495 2496 /** 2497 * @} 2498 */ 2499 2500 /** 2501 * @defgroup LLVMCCoreValueInstructionTerminator Terminators 2502 * 2503 * Functions in this group only apply to instructions that map to 2504 * llvm::TerminatorInst instances. 2505 * 2506 * @{ 2507 */ 2508 2509 /** 2510 * Return the number of successors that this terminator has. 2511 * 2512 * @see llvm::TerminatorInst::getNumSuccessors 2513 */ 2514 unsigned LLVMGetNumSuccessors(LLVMValueRef Term); 2515 2516 /** 2517 * Return the specified successor. 2518 * 2519 * @see llvm::TerminatorInst::getSuccessor 2520 */ 2521 LLVMBasicBlockRef LLVMGetSuccessor(LLVMValueRef Term, unsigned i); 2522 2523 /** 2524 * Update the specified successor to point at the provided block. 2525 * 2526 * @see llvm::TerminatorInst::setSuccessor 2527 */ 2528 void LLVMSetSuccessor(LLVMValueRef Term, unsigned i, LLVMBasicBlockRef block); 2529 2530 /** 2531 * Return if a branch is conditional. 2532 * 2533 * This only works on llvm::BranchInst instructions. 2534 * 2535 * @see llvm::BranchInst::isConditional 2536 */ 2537 LLVMBool LLVMIsConditional(LLVMValueRef Branch); 2538 2539 /** 2540 * Return the condition of a branch instruction. 2541 * 2542 * This only works on llvm::BranchInst instructions. 2543 * 2544 * @see llvm::BranchInst::getCondition 2545 */ 2546 LLVMValueRef LLVMGetCondition(LLVMValueRef Branch); 2547 2548 /** 2549 * Set the condition of a branch instruction. 2550 * 2551 * This only works on llvm::BranchInst instructions. 2552 * 2553 * @see llvm::BranchInst::setCondition 2554 */ 2555 void LLVMSetCondition(LLVMValueRef Branch, LLVMValueRef Cond); 2556 2557 /** 2558 * Obtain the default destination basic block of a switch instruction. 2559 * 2560 * This only works on llvm::SwitchInst instructions. 2561 * 2562 * @see llvm::SwitchInst::getDefaultDest() 2563 */ 2564 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr); 2565 2566 /** 2567 * @} 2568 */ 2569 2570 /** 2571 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes 2572 * 2573 * Functions in this group only apply to instructions that map to 2574 * llvm::PHINode instances. 2575 * 2576 * @{ 2577 */ 2578 2579 /** 2580 * Add an incoming value to the end of a PHI list. 2581 */ 2582 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues, 2583 LLVMBasicBlockRef *IncomingBlocks, unsigned Count); 2584 2585 /** 2586 * Obtain the number of incoming basic blocks to a PHI node. 2587 */ 2588 unsigned LLVMCountIncoming(LLVMValueRef PhiNode); 2589 2590 /** 2591 * Obtain an incoming value to a PHI node as an LLVMValueRef. 2592 */ 2593 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index); 2594 2595 /** 2596 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef. 2597 */ 2598 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index); 2599 2600 /** 2601 * @} 2602 */ 2603 2604 /** 2605 * @} 2606 */ 2607 2608 /** 2609 * @} 2610 */ 2611 2612 /** 2613 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders 2614 * 2615 * An instruction builder represents a point within a basic block and is 2616 * the exclusive means of building instructions using the C interface. 2617 * 2618 * @{ 2619 */ 2620 2621 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C); 2622 LLVMBuilderRef LLVMCreateBuilder(void); 2623 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block, 2624 LLVMValueRef Instr); 2625 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr); 2626 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block); 2627 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder); 2628 void LLVMClearInsertionPosition(LLVMBuilderRef Builder); 2629 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr); 2630 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr, 2631 const char *Name); 2632 void LLVMDisposeBuilder(LLVMBuilderRef Builder); 2633 2634 /* Metadata */ 2635 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L); 2636 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder); 2637 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst); 2638 2639 /* Terminators */ 2640 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef); 2641 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V); 2642 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals, 2643 unsigned N); 2644 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest); 2645 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If, 2646 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else); 2647 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V, 2648 LLVMBasicBlockRef Else, unsigned NumCases); 2649 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr, 2650 unsigned NumDests); 2651 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn, 2652 LLVMValueRef *Args, unsigned NumArgs, 2653 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch, 2654 const char *Name); 2655 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty, 2656 LLVMValueRef PersFn, unsigned NumClauses, 2657 const char *Name); 2658 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn); 2659 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef); 2660 2661 /* Add a case to the switch instruction */ 2662 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal, 2663 LLVMBasicBlockRef Dest); 2664 2665 /* Add a destination to the indirectbr instruction */ 2666 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest); 2667 2668 /* Add a catch or filter clause to the landingpad instruction */ 2669 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal); 2670 2671 /* Set the 'cleanup' flag in the landingpad instruction */ 2672 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val); 2673 2674 /* Arithmetic */ 2675 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2676 const char *Name); 2677 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2678 const char *Name); 2679 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2680 const char *Name); 2681 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2682 const char *Name); 2683 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2684 const char *Name); 2685 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2686 const char *Name); 2687 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2688 const char *Name); 2689 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2690 const char *Name); 2691 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2692 const char *Name); 2693 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2694 const char *Name); 2695 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2696 const char *Name); 2697 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2698 const char *Name); 2699 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2700 const char *Name); 2701 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2702 const char *Name); 2703 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2704 const char *Name); 2705 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2706 const char *Name); 2707 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2708 const char *Name); 2709 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2710 const char *Name); 2711 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2712 const char *Name); 2713 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2714 const char *Name); 2715 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2716 const char *Name); 2717 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2718 const char *Name); 2719 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2720 const char *Name); 2721 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2722 const char *Name); 2723 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2724 const char *Name); 2725 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op, 2726 LLVMValueRef LHS, LLVMValueRef RHS, 2727 const char *Name); 2728 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name); 2729 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V, 2730 const char *Name); 2731 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V, 2732 const char *Name); 2733 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name); 2734 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name); 2735 2736 /* Memory */ 2737 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name); 2738 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty, 2739 LLVMValueRef Val, const char *Name); 2740 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name); 2741 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty, 2742 LLVMValueRef Val, const char *Name); 2743 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal); 2744 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal, 2745 const char *Name); 2746 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr); 2747 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer, 2748 LLVMValueRef *Indices, unsigned NumIndices, 2749 const char *Name); 2750 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer, 2751 LLVMValueRef *Indices, unsigned NumIndices, 2752 const char *Name); 2753 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer, 2754 unsigned Idx, const char *Name); 2755 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str, 2756 const char *Name); 2757 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str, 2758 const char *Name); 2759 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst); 2760 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile); 2761 2762 /* Casts */ 2763 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val, 2764 LLVMTypeRef DestTy, const char *Name); 2765 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val, 2766 LLVMTypeRef DestTy, const char *Name); 2767 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val, 2768 LLVMTypeRef DestTy, const char *Name); 2769 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val, 2770 LLVMTypeRef DestTy, const char *Name); 2771 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val, 2772 LLVMTypeRef DestTy, const char *Name); 2773 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val, 2774 LLVMTypeRef DestTy, const char *Name); 2775 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val, 2776 LLVMTypeRef DestTy, const char *Name); 2777 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val, 2778 LLVMTypeRef DestTy, const char *Name); 2779 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val, 2780 LLVMTypeRef DestTy, const char *Name); 2781 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val, 2782 LLVMTypeRef DestTy, const char *Name); 2783 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val, 2784 LLVMTypeRef DestTy, const char *Name); 2785 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val, 2786 LLVMTypeRef DestTy, const char *Name); 2787 LLVMValueRef LLVMBuildAddrSpaceCast(LLVMBuilderRef, LLVMValueRef Val, 2788 LLVMTypeRef DestTy, const char *Name); 2789 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val, 2790 LLVMTypeRef DestTy, const char *Name); 2791 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val, 2792 LLVMTypeRef DestTy, const char *Name); 2793 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val, 2794 LLVMTypeRef DestTy, const char *Name); 2795 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val, 2796 LLVMTypeRef DestTy, const char *Name); 2797 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val, 2798 LLVMTypeRef DestTy, const char *Name); 2799 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/ 2800 LLVMTypeRef DestTy, const char *Name); 2801 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val, 2802 LLVMTypeRef DestTy, const char *Name); 2803 2804 /* Comparisons */ 2805 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op, 2806 LLVMValueRef LHS, LLVMValueRef RHS, 2807 const char *Name); 2808 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op, 2809 LLVMValueRef LHS, LLVMValueRef RHS, 2810 const char *Name); 2811 2812 /* Miscellaneous instructions */ 2813 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name); 2814 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn, 2815 LLVMValueRef *Args, unsigned NumArgs, 2816 const char *Name); 2817 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If, 2818 LLVMValueRef Then, LLVMValueRef Else, 2819 const char *Name); 2820 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty, 2821 const char *Name); 2822 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal, 2823 LLVMValueRef Index, const char *Name); 2824 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal, 2825 LLVMValueRef EltVal, LLVMValueRef Index, 2826 const char *Name); 2827 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1, 2828 LLVMValueRef V2, LLVMValueRef Mask, 2829 const char *Name); 2830 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal, 2831 unsigned Index, const char *Name); 2832 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal, 2833 LLVMValueRef EltVal, unsigned Index, 2834 const char *Name); 2835 2836 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val, 2837 const char *Name); 2838 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val, 2839 const char *Name); 2840 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS, 2841 LLVMValueRef RHS, const char *Name); 2842 LLVMValueRef LLVMBuildFence(LLVMBuilderRef B, LLVMAtomicOrdering ordering, 2843 LLVMBool singleThread, const char *Name); 2844 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B, LLVMAtomicRMWBinOp op, 2845 LLVMValueRef PTR, LLVMValueRef Val, 2846 LLVMAtomicOrdering ordering, 2847 LLVMBool singleThread); 2848 2849 /** 2850 * @} 2851 */ 2852 2853 /** 2854 * @defgroup LLVMCCoreModuleProvider Module Providers 2855 * 2856 * @{ 2857 */ 2858 2859 /** 2860 * Changes the type of M so it can be passed to FunctionPassManagers and the 2861 * JIT. They take ModuleProviders for historical reasons. 2862 */ 2863 LLVMModuleProviderRef 2864 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M); 2865 2866 /** 2867 * Destroys the module M. 2868 */ 2869 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M); 2870 2871 /** 2872 * @} 2873 */ 2874 2875 /** 2876 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers 2877 * 2878 * @{ 2879 */ 2880 2881 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path, 2882 LLVMMemoryBufferRef *OutMemBuf, 2883 char **OutMessage); 2884 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf, 2885 char **OutMessage); 2886 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData, 2887 size_t InputDataLength, 2888 const char *BufferName, 2889 LLVMBool RequiresNullTerminator); 2890 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData, 2891 size_t InputDataLength, 2892 const char *BufferName); 2893 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf); 2894 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf); 2895 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf); 2896 2897 /** 2898 * @} 2899 */ 2900 2901 /** 2902 * @defgroup LLVMCCorePassRegistry Pass Registry 2903 * 2904 * @{ 2905 */ 2906 2907 /** Return the global pass registry, for use with initialization functions. 2908 @see llvm::PassRegistry::getPassRegistry */ 2909 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void); 2910 2911 /** 2912 * @} 2913 */ 2914 2915 /** 2916 * @defgroup LLVMCCorePassManagers Pass Managers 2917 * 2918 * @{ 2919 */ 2920 2921 /** Constructs a new whole-module pass pipeline. This type of pipeline is 2922 suitable for link-time optimization and whole-module transformations. 2923 @see llvm::PassManager::PassManager */ 2924 LLVMPassManagerRef LLVMCreatePassManager(void); 2925 2926 /** Constructs a new function-by-function pass pipeline over the module 2927 provider. It does not take ownership of the module provider. This type of 2928 pipeline is suitable for code generation and JIT compilation tasks. 2929 @see llvm::FunctionPassManager::FunctionPassManager */ 2930 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M); 2931 2932 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */ 2933 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP); 2934 2935 /** Initializes, executes on the provided module, and finalizes all of the 2936 passes scheduled in the pass manager. Returns 1 if any of the passes 2937 modified the module, 0 otherwise. 2938 @see llvm::PassManager::run(Module&) */ 2939 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M); 2940 2941 /** Initializes all of the function passes scheduled in the function pass 2942 manager. Returns 1 if any of the passes modified the module, 0 otherwise. 2943 @see llvm::FunctionPassManager::doInitialization */ 2944 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM); 2945 2946 /** Executes all of the function passes scheduled in the function pass manager 2947 on the provided function. Returns 1 if any of the passes modified the 2948 function, false otherwise. 2949 @see llvm::FunctionPassManager::run(Function&) */ 2950 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F); 2951 2952 /** Finalizes all of the function passes scheduled in in the function pass 2953 manager. Returns 1 if any of the passes modified the module, 0 otherwise. 2954 @see llvm::FunctionPassManager::doFinalization */ 2955 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM); 2956 2957 /** Frees the memory of a pass pipeline. For function pipelines, does not free 2958 the module provider. 2959 @see llvm::PassManagerBase::~PassManagerBase. */ 2960 void LLVMDisposePassManager(LLVMPassManagerRef PM); 2961 2962 /** 2963 * @} 2964 */ 2965 2966 /** 2967 * @defgroup LLVMCCoreThreading Threading 2968 * 2969 * Handle the structures needed to make LLVM safe for multithreading. 2970 * 2971 * @{ 2972 */ 2973 2974 /** Deprecated: Multi-threading can only be enabled/disabled with the compile 2975 time define LLVM_ENABLE_THREADS. This function always returns 2976 LLVMIsMultithreaded(). */ 2977 LLVMBool LLVMStartMultithreaded(void); 2978 2979 /** Deprecated: Multi-threading can only be enabled/disabled with the compile 2980 time define LLVM_ENABLE_THREADS. */ 2981 void LLVMStopMultithreaded(void); 2982 2983 /** Check whether LLVM is executing in thread-safe mode or not. 2984 @see llvm::llvm_is_multithreaded */ 2985 LLVMBool LLVMIsMultithreaded(void); 2986 2987 /** 2988 * @} 2989 */ 2990 2991 /** 2992 * @} 2993 */ 2994 2995 /** 2996 * @} 2997 */ 2998 2999 #ifdef __cplusplus 3000 } 3001 #endif /* !defined(__cplusplus) */ 3002 3003 #endif /* !defined(LLVM_C_CORE_H) */ 3004