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