include/llvm-c/Core.h

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