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  * Replace all uses of a value with another one.
1216  *
1217  * @see llvm::Value::replaceAllUsesWith()
1218  */
1219 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1220
1221 /**
1222  * Determine whether the specified constant instance is constant.
1223  */
1224 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1225
1226 /**
1227  * Determine whether a value instance is undefined.
1228  */
1229 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1230
1231 /**
1232  * Convert value instances between types.
1233  *
1234  * Internally, an LLVMValueRef is "pinned" to a specific type. This
1235  * series of functions allows you to cast an instance to a specific
1236  * type.
1237  *
1238  * If the cast is not valid for the specified type, NULL is returned.
1239  *
1240  * @see llvm::dyn_cast_or_null<>
1241  */
1242 #define LLVM_DECLARE_VALUE_CAST(name) \
1243   LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1244 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1245
1246 /**
1247  * @}
1248  */
1249
1250 /**
1251  * @defgroup LLVMCCoreValueUses Usage
1252  *
1253  * This module defines functions that allow you to inspect the uses of a
1254  * LLVMValueRef.
1255  *
1256  * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1257  * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1258  * llvm::User and llvm::Value.
1259  *
1260  * @{
1261  */
1262
1263 /**
1264  * Obtain the first use of a value.
1265  *
1266  * Uses are obtained in an iterator fashion. First, call this function
1267  * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1268  * on that instance and all subsequently obtained instances until
1269  * LLVMGetNextUse() returns NULL.
1270  *
1271  * @see llvm::Value::use_begin()
1272  */
1273 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1274
1275 /**
1276  * Obtain the next use of a value.
1277  *
1278  * This effectively advances the iterator. It returns NULL if you are on
1279  * the final use and no more are available.
1280  */
1281 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1282
1283 /**
1284  * Obtain the user value for a user.
1285  *
1286  * The returned value corresponds to a llvm::User type.
1287  *
1288  * @see llvm::Use::getUser()
1289  */
1290 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1291
1292 /**
1293  * Obtain the value this use corresponds to.
1294  *
1295  * @see llvm::Use::get().
1296  */
1297 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1298
1299 /**
1300  * @}
1301  */
1302
1303 /**
1304  * @defgroup LLVMCCoreValueUser User value
1305  *
1306  * Function in this group pertain to LLVMValueRef instances that descent
1307  * from llvm::User. This includes constants, instructions, and
1308  * operators.
1309  *
1310  * @{
1311  */
1312
1313 /**
1314  * Obtain an operand at a specific index in a llvm::User value.
1315  *
1316  * @see llvm::User::getOperand()
1317  */
1318 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1319
1320 /**
1321  * Set an operand at a specific index in a llvm::User value.
1322  *
1323  * @see llvm::User::setOperand()
1324  */
1325 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1326
1327 /**
1328  * Obtain the number of operands in a llvm::User value.
1329  *
1330  * @see llvm::User::getNumOperands()
1331  */
1332 int LLVMGetNumOperands(LLVMValueRef Val);
1333
1334 /**
1335  * @}
1336  */
1337
1338 /**
1339  * @defgroup LLVMCCoreValueConstant Constants
1340  *
1341  * This section contains APIs for interacting with LLVMValueRef that
1342  * correspond to llvm::Constant instances.
1343  *
1344  * These functions will work for any LLVMValueRef in the llvm::Constant
1345  * class hierarchy.
1346  *
1347  * @{
1348  */
1349
1350 /**
1351  * Obtain a constant value referring to the null instance of a type.
1352  *
1353  * @see llvm::Constant::getNullValue()
1354  */
1355 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1356
1357 /**
1358  * Obtain a constant value referring to the instance of a type
1359  * consisting of all ones.
1360  *
1361  * This is only valid for integer types.
1362  *
1363  * @see llvm::Constant::getAllOnesValue()
1364  */
1365 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1366
1367 /**
1368  * Obtain a constant value referring to an undefined value of a type.
1369  *
1370  * @see llvm::UndefValue::get()
1371  */
1372 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1373
1374 /**
1375  * Determine whether a value instance is null.
1376  *
1377  * @see llvm::Constant::isNullValue()
1378  */
1379 LLVMBool LLVMIsNull(LLVMValueRef Val);
1380
1381 /**
1382  * Obtain a constant that is a constant pointer pointing to NULL for a
1383  * specified type.
1384  */
1385 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1386
1387 /**
1388  * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1389  *
1390  * Functions in this group model LLVMValueRef instances that correspond
1391  * to constants referring to scalar types.
1392  *
1393  * For integer types, the LLVMTypeRef parameter should correspond to a
1394  * llvm::IntegerType instance and the returned LLVMValueRef will
1395  * correspond to a llvm::ConstantInt.
1396  *
1397  * For floating point types, the LLVMTypeRef returned corresponds to a
1398  * llvm::ConstantFP.
1399  *
1400  * @{
1401  */
1402
1403 /**
1404  * Obtain a constant value for an integer type.
1405  *
1406  * The returned value corresponds to a llvm::ConstantInt.
1407  *
1408  * @see llvm::ConstantInt::get()
1409  *
1410  * @param IntTy Integer type to obtain value of.
1411  * @param N The value the returned instance should refer to.
1412  * @param SignExtend Whether to sign extend the produced value.
1413  */
1414 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1415                           LLVMBool SignExtend);
1416
1417 /**
1418  * Obtain a constant value for an integer of arbitrary precision.
1419  *
1420  * @see llvm::ConstantInt::get()
1421  */
1422 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1423                                               unsigned NumWords,
1424                                               const uint64_t Words[]);
1425
1426 /**
1427  * Obtain a constant value for an integer parsed from a string.
1428  *
1429  * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1430  * string's length is available, it is preferred to call that function
1431  * instead.
1432  *
1433  * @see llvm::ConstantInt::get()
1434  */
1435 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1436                                   uint8_t Radix);
1437
1438 /**
1439  * Obtain a constant value for an integer parsed from a string with
1440  * specified length.
1441  *
1442  * @see llvm::ConstantInt::get()
1443  */
1444 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1445                                          unsigned SLen, uint8_t Radix);
1446
1447 /**
1448  * Obtain a constant value referring to a double floating point value.
1449  */
1450 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1451
1452 /**
1453  * Obtain a constant for a floating point value parsed from a string.
1454  *
1455  * A similar API, LLVMConstRealOfStringAndSize is also available. It
1456  * should be used if the input string's length is known.
1457  */
1458 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1459
1460 /**
1461  * Obtain a constant for a floating point value parsed from a string.
1462  */
1463 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1464                                           unsigned SLen);
1465
1466 /**
1467  * Obtain the zero extended value for an integer constant value.
1468  *
1469  * @see llvm::ConstantInt::getZExtValue()
1470  */
1471 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1472
1473 /**
1474  * Obtain the sign extended value for an integer constant value.
1475  *
1476  * @see llvm::ConstantInt::getSExtValue()
1477  */
1478 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1479
1480 /**
1481  * @}
1482  */
1483
1484 /**
1485  * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1486  *
1487  * Functions in this group operate on composite constants.
1488  *
1489  * @{
1490  */
1491
1492 /**
1493  * Create a ConstantDataSequential and initialize it with a string.
1494  *
1495  * @see llvm::ConstantDataArray::getString()
1496  */
1497 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1498                                       unsigned Length, LLVMBool DontNullTerminate);
1499
1500 /**
1501  * Create a ConstantDataSequential with string content in the global context.
1502  *
1503  * This is the same as LLVMConstStringInContext except it operates on the
1504  * global context.
1505  *
1506  * @see LLVMConstStringInContext()
1507  * @see llvm::ConstantDataArray::getString()
1508  */
1509 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1510                              LLVMBool DontNullTerminate);
1511
1512 /**
1513  * Create an anonymous ConstantStruct with the specified values.
1514  *
1515  * @see llvm::ConstantStruct::getAnon()
1516  */
1517 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1518                                       LLVMValueRef *ConstantVals,
1519                                       unsigned Count, LLVMBool Packed);
1520
1521 /**
1522  * Create a ConstantStruct in the global Context.
1523  *
1524  * This is the same as LLVMConstStructInContext except it operates on the
1525  * global Context.
1526  *
1527  * @see LLVMConstStructInContext()
1528  */
1529 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1530                              LLVMBool Packed);
1531
1532 /**
1533  * Create a ConstantArray from values.
1534  *
1535  * @see llvm::ConstantArray::get()
1536  */
1537 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1538                             LLVMValueRef *ConstantVals, unsigned Length);
1539
1540 /**
1541  * Create a non-anonymous ConstantStruct from values.
1542  *
1543  * @see llvm::ConstantStruct::get()
1544  */
1545 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1546                                   LLVMValueRef *ConstantVals,
1547                                   unsigned Count);
1548
1549 /**
1550  * Create a ConstantVector from values.
1551  *
1552  * @see llvm::ConstantVector::get()
1553  */
1554 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1555
1556 /**
1557  * @}
1558  */
1559
1560 /**
1561  * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1562  *
1563  * Functions in this group correspond to APIs on llvm::ConstantExpr.
1564  *
1565  * @see llvm::ConstantExpr.
1566  *
1567  * @{
1568  */
1569 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1570 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1571 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1572 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1573 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1574 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1575 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1576 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1577 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1578 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1579 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1580 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1581 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1582 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1583 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1584 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1585 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1586 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1587 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1588 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1589 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1590 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1591 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1592 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1593 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1594 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1595 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1596 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1597 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1598 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1599 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1600                            LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1601 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1602                            LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1603 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1604 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1605 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1606 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1607                           LLVMValueRef *ConstantIndices, unsigned NumIndices);
1608 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1609                                   LLVMValueRef *ConstantIndices,
1610                                   unsigned NumIndices);
1611 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1612 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1613 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1614 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1615 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1616 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1617 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1618 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1619 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1620 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1621 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1622 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1623 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1624                                     LLVMTypeRef ToType);
1625 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1626                                     LLVMTypeRef ToType);
1627 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1628                                      LLVMTypeRef ToType);
1629 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1630                                   LLVMTypeRef ToType);
1631 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1632                               LLVMBool isSigned);
1633 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1634 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1635                              LLVMValueRef ConstantIfTrue,
1636                              LLVMValueRef ConstantIfFalse);
1637 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1638                                      LLVMValueRef IndexConstant);
1639 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1640                                     LLVMValueRef ElementValueConstant,
1641                                     LLVMValueRef IndexConstant);
1642 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1643                                     LLVMValueRef VectorBConstant,
1644                                     LLVMValueRef MaskConstant);
1645 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1646                                    unsigned NumIdx);
1647 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1648                                   LLVMValueRef ElementValueConstant,
1649                                   unsigned *IdxList, unsigned NumIdx);
1650 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1651                                 const char *AsmString, const char *Constraints,
1652                                 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1653 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1654
1655 /**
1656  * @}
1657  */
1658
1659 /**
1660  * @defgroup LLVMCCoreValueConstantGlobals Global Values
1661  *
1662  * This group contains functions that operate on global values. Functions in
1663  * this group relate to functions in the llvm::GlobalValue class tree.
1664  *
1665  * @see llvm::GlobalValue
1666  *
1667  * @{
1668  */
1669
1670 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1671 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1672 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1673 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1674 const char *LLVMGetSection(LLVMValueRef Global);
1675 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1676 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1677 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1678
1679 /**
1680  * @defgroup LLVMCCoreValueWithAlignment Values with alignment
1681  *
1682  * Functions in this group only apply to values with alignment, i.e.
1683  * global variables, load and store instructions.
1684  */
1685
1686 /**
1687  * Obtain the preferred alignment of the value.
1688  * @see llvm::LoadInst::getAlignment()
1689  * @see llvm::StoreInst::getAlignment()
1690  * @see llvm::GlobalValue::getAlignment()
1691  */
1692 unsigned LLVMGetAlignment(LLVMValueRef V);
1693
1694 /**
1695  * Set the preferred alignment of the value.
1696  * @see llvm::LoadInst::setAlignment()
1697  * @see llvm::StoreInst::setAlignment()
1698  * @see llvm::GlobalValue::setAlignment()
1699  */
1700 void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes);
1701
1702 /**
1703   * @}
1704   */
1705
1706 /**
1707  * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1708  *
1709  * This group contains functions that operate on global variable values.
1710  *
1711  * @see llvm::GlobalVariable
1712  *
1713  * @{
1714  */
1715 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1716 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1717                                          const char *Name,
1718                                          unsigned AddressSpace);
1719 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1720 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1721 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1722 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1723 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1724 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1725 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1726 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1727 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1728 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1729 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1730 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1731 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1732 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1733 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1734 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1735
1736 /**
1737  * @}
1738  */
1739
1740 /**
1741  * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1742  *
1743  * This group contains function that operate on global alias values.
1744  *
1745  * @see llvm::GlobalAlias
1746  *
1747  * @{
1748  */
1749 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1750                           const char *Name);
1751
1752 /**
1753  * @}
1754  */
1755
1756 /**
1757  * @defgroup LLVMCCoreValueFunction Function values
1758  *
1759  * Functions in this group operate on LLVMValueRef instances that
1760  * correspond to llvm::Function instances.
1761  *
1762  * @see llvm::Function
1763  *
1764  * @{
1765  */
1766
1767 /**
1768  * Remove a function from its containing module and deletes it.
1769  *
1770  * @see llvm::Function::eraseFromParent()
1771  */
1772 void LLVMDeleteFunction(LLVMValueRef Fn);
1773
1774 /**
1775  * Obtain the ID number from a function instance.
1776  *
1777  * @see llvm::Function::getIntrinsicID()
1778  */
1779 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1780
1781 /**
1782  * Obtain the calling function of a function.
1783  *
1784  * The returned value corresponds to the LLVMCallConv enumeration.
1785  *
1786  * @see llvm::Function::getCallingConv()
1787  */
1788 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1789
1790 /**
1791  * Set the calling convention of a function.
1792  *
1793  * @see llvm::Function::setCallingConv()
1794  *
1795  * @param Fn Function to operate on
1796  * @param CC LLVMCallConv to set calling convention to
1797  */
1798 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1799
1800 /**
1801  * Obtain the name of the garbage collector to use during code
1802  * generation.
1803  *
1804  * @see llvm::Function::getGC()
1805  */
1806 const char *LLVMGetGC(LLVMValueRef Fn);
1807
1808 /**
1809  * Define the garbage collector to use during code generation.
1810  *
1811  * @see llvm::Function::setGC()
1812  */
1813 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1814
1815 /**
1816  * Add an attribute to a function.
1817  *
1818  * @see llvm::Function::addAttribute()
1819  */
1820 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1821
1822 /**
1823  * Add a target-dependent attribute to a fuction
1824  * @see llvm::AttrBuilder::addAttribute()
1825  */
1826 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1827                                         const char *V);
1828
1829 /**
1830  * Obtain an attribute from a function.
1831  *
1832  * @see llvm::Function::getAttributes()
1833  */
1834 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1835
1836 /**
1837  * Remove an attribute from a function.
1838  */
1839 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1840
1841 /**
1842  * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1843  *
1844  * Functions in this group relate to arguments/parameters on functions.
1845  *
1846  * Functions in this group expect LLVMValueRef instances that correspond
1847  * to llvm::Function instances.
1848  *
1849  * @{
1850  */
1851
1852 /**
1853  * Obtain the number of parameters in a function.
1854  *
1855  * @see llvm::Function::arg_size()
1856  */
1857 unsigned LLVMCountParams(LLVMValueRef Fn);
1858
1859 /**
1860  * Obtain the parameters in a function.
1861  *
1862  * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1863  * at least LLVMCountParams() long. This array will be filled with
1864  * LLVMValueRef instances which correspond to the parameters the
1865  * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1866  * instance.
1867  *
1868  * @see llvm::Function::arg_begin()
1869  */
1870 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1871
1872 /**
1873  * Obtain the parameter at the specified index.
1874  *
1875  * Parameters are indexed from 0.
1876  *
1877  * @see llvm::Function::arg_begin()
1878  */
1879 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1880
1881 /**
1882  * Obtain the function to which this argument belongs.
1883  *
1884  * Unlike other functions in this group, this one takes an LLVMValueRef
1885  * that corresponds to a llvm::Attribute.
1886  *
1887  * The returned LLVMValueRef is the llvm::Function to which this
1888  * argument belongs.
1889  */
1890 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1891
1892 /**
1893  * Obtain the first parameter to a function.
1894  *
1895  * @see llvm::Function::arg_begin()
1896  */
1897 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1898
1899 /**
1900  * Obtain the last parameter to a function.
1901  *
1902  * @see llvm::Function::arg_end()
1903  */
1904 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
1905
1906 /**
1907  * Obtain the next parameter to a function.
1908  *
1909  * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
1910  * actually a wrapped iterator) and obtains the next parameter from the
1911  * underlying iterator.
1912  */
1913 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
1914
1915 /**
1916  * Obtain the previous parameter to a function.
1917  *
1918  * This is the opposite of LLVMGetNextParam().
1919  */
1920 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
1921
1922 /**
1923  * Add an attribute to a function argument.
1924  *
1925  * @see llvm::Argument::addAttr()
1926  */
1927 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1928
1929 /**
1930  * Remove an attribute from a function argument.
1931  *
1932  * @see llvm::Argument::removeAttr()
1933  */
1934 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1935
1936 /**
1937  * Get an attribute from a function argument.
1938  */
1939 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
1940
1941 /**
1942  * Set the alignment for a function parameter.
1943  *
1944  * @see llvm::Argument::addAttr()
1945  * @see llvm::AttrBuilder::addAlignmentAttr()
1946  */
1947 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
1948
1949 /**
1950  * @}
1951  */
1952
1953 /**
1954  * @}
1955  */
1956
1957 /**
1958  * @}
1959  */
1960
1961 /**
1962  * @}
1963  */
1964
1965 /**
1966  * @defgroup LLVMCCoreValueMetadata Metadata
1967  *
1968  * @{
1969  */
1970
1971 /**
1972  * Obtain a MDString value from a context.
1973  *
1974  * The returned instance corresponds to the llvm::MDString class.
1975  *
1976  * The instance is specified by string data of a specified length. The
1977  * string content is copied, so the backing memory can be freed after
1978  * this function returns.
1979  */
1980 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
1981                                    unsigned SLen);
1982
1983 /**
1984  * Obtain a MDString value from the global context.
1985  */
1986 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
1987
1988 /**
1989  * Obtain a MDNode value from a context.
1990  *
1991  * The returned value corresponds to the llvm::MDNode class.
1992  */
1993 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
1994                                  unsigned Count);
1995
1996 /**
1997  * Obtain a MDNode value from the global context.
1998  */
1999 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
2000
2001 /**
2002  * Obtain the underlying string from a MDString value.
2003  *
2004  * @param V Instance to obtain string from.
2005  * @param Len Memory address which will hold length of returned string.
2006  * @return String data in MDString.
2007  */
2008 const char  *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
2009
2010 /**
2011  * Obtain the number of operands from an MDNode value.
2012  *
2013  * @param V MDNode to get number of operands from.
2014  * @return Number of operands of the MDNode.
2015  */
2016 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
2017
2018 /**
2019  * Obtain the given MDNode's operands.
2020  *
2021  * The passed LLVMValueRef pointer should point to enough memory to hold all of
2022  * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
2023  * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
2024  * MDNode's operands.
2025  *
2026  * @param V MDNode to get the operands from.
2027  * @param Dest Destination array for operands.
2028  */
2029 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
2030
2031 /**
2032  * @}
2033  */
2034
2035 /**
2036  * @defgroup LLVMCCoreValueBasicBlock Basic Block
2037  *
2038  * A basic block represents a single entry single exit section of code.
2039  * Basic blocks contain a list of instructions which form the body of
2040  * the block.
2041  *
2042  * Basic blocks belong to functions. They have the type of label.
2043  *
2044  * Basic blocks are themselves values. However, the C API models them as
2045  * LLVMBasicBlockRef.
2046  *
2047  * @see llvm::BasicBlock
2048  *
2049  * @{
2050  */
2051
2052 /**
2053  * Convert a basic block instance to a value type.
2054  */
2055 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
2056
2057 /**
2058  * Determine whether an LLVMValueRef is itself a basic block.
2059  */
2060 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
2061
2062 /**
2063  * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
2064  */
2065 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
2066
2067 /**
2068  * Obtain the function to which a basic block belongs.
2069  *
2070  * @see llvm::BasicBlock::getParent()
2071  */
2072 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2073
2074 /**
2075  * Obtain the terminator instruction for a basic block.
2076  *
2077  * If the basic block does not have a terminator (it is not well-formed
2078  * if it doesn't), then NULL is returned.
2079  *
2080  * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2081  *
2082  * @see llvm::BasicBlock::getTerminator()
2083  */
2084 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2085
2086 /**
2087  * Obtain the number of basic blocks in a function.
2088  *
2089  * @param Fn Function value to operate on.
2090  */
2091 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2092
2093 /**
2094  * Obtain all of the basic blocks in a function.
2095  *
2096  * This operates on a function value. The BasicBlocks parameter is a
2097  * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2098  * LLVMCountBasicBlocks() in length. This array is populated with
2099  * LLVMBasicBlockRef instances.
2100  */
2101 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2102
2103 /**
2104  * Obtain the first basic block in a function.
2105  *
2106  * The returned basic block can be used as an iterator. You will likely
2107  * eventually call into LLVMGetNextBasicBlock() with it.
2108  *
2109  * @see llvm::Function::begin()
2110  */
2111 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2112
2113 /**
2114  * Obtain the last basic block in a function.
2115  *
2116  * @see llvm::Function::end()
2117  */
2118 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2119
2120 /**
2121  * Advance a basic block iterator.
2122  */
2123 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2124
2125 /**
2126  * Go backwards in a basic block iterator.
2127  */
2128 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2129
2130 /**
2131  * Obtain the basic block that corresponds to the entry point of a
2132  * function.
2133  *
2134  * @see llvm::Function::getEntryBlock()
2135  */
2136 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2137
2138 /**
2139  * Append a basic block to the end of a function.
2140  *
2141  * @see llvm::BasicBlock::Create()
2142  */
2143 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2144                                                 LLVMValueRef Fn,
2145                                                 const char *Name);
2146
2147 /**
2148  * Append a basic block to the end of a function using the global
2149  * context.
2150  *
2151  * @see llvm::BasicBlock::Create()
2152  */
2153 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2154
2155 /**
2156  * Insert a basic block in a function before another basic block.
2157  *
2158  * The function to add to is determined by the function of the
2159  * passed basic block.
2160  *
2161  * @see llvm::BasicBlock::Create()
2162  */
2163 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2164                                                 LLVMBasicBlockRef BB,
2165                                                 const char *Name);
2166
2167 /**
2168  * Insert a basic block in a function using the global context.
2169  *
2170  * @see llvm::BasicBlock::Create()
2171  */
2172 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2173                                        const char *Name);
2174
2175 /**
2176  * Remove a basic block from a function and delete it.
2177  *
2178  * This deletes the basic block from its containing function and deletes
2179  * the basic block itself.
2180  *
2181  * @see llvm::BasicBlock::eraseFromParent()
2182  */
2183 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2184
2185 /**
2186  * Remove a basic block from a function.
2187  *
2188  * This deletes the basic block from its containing function but keep
2189  * the basic block alive.
2190  *
2191  * @see llvm::BasicBlock::removeFromParent()
2192  */
2193 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2194
2195 /**
2196  * Move a basic block to before another one.
2197  *
2198  * @see llvm::BasicBlock::moveBefore()
2199  */
2200 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2201
2202 /**
2203  * Move a basic block to after another one.
2204  *
2205  * @see llvm::BasicBlock::moveAfter()
2206  */
2207 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2208
2209 /**
2210  * Obtain the first instruction in a basic block.
2211  *
2212  * The returned LLVMValueRef corresponds to a llvm::Instruction
2213  * instance.
2214  */
2215 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2216
2217 /**
2218  * Obtain the last instruction in a basic block.
2219  *
2220  * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2221  */
2222 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2223
2224 /**
2225  * @}
2226  */
2227
2228 /**
2229  * @defgroup LLVMCCoreValueInstruction Instructions
2230  *
2231  * Functions in this group relate to the inspection and manipulation of
2232  * individual instructions.
2233  *
2234  * In the C++ API, an instruction is modeled by llvm::Instruction. This
2235  * class has a large number of descendents. llvm::Instruction is a
2236  * llvm::Value and in the C API, instructions are modeled by
2237  * LLVMValueRef.
2238  *
2239  * This group also contains sub-groups which operate on specific
2240  * llvm::Instruction types, e.g. llvm::CallInst.
2241  *
2242  * @{
2243  */
2244
2245 /**
2246  * Determine whether an instruction has any metadata attached.
2247  */
2248 int LLVMHasMetadata(LLVMValueRef Val);
2249
2250 /**
2251  * Return metadata associated with an instruction value.
2252  */
2253 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2254
2255 /**
2256  * Set metadata associated with an instruction value.
2257  */
2258 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2259
2260 /**
2261  * Obtain the basic block to which an instruction belongs.
2262  *
2263  * @see llvm::Instruction::getParent()
2264  */
2265 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2266
2267 /**
2268  * Obtain the instruction that occurs after the one specified.
2269  *
2270  * The next instruction will be from the same basic block.
2271  *
2272  * If this is the last instruction in a basic block, NULL will be
2273  * returned.
2274  */
2275 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2276
2277 /**
2278  * Obtain the instruction that occurred before this one.
2279  *
2280  * If the instruction is the first instruction in a basic block, NULL
2281  * will be returned.
2282  */
2283 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2284
2285 /**
2286  * Remove and delete an instruction.
2287  *
2288  * The instruction specified is removed from its containing building
2289  * block and then deleted.
2290  *
2291  * @see llvm::Instruction::eraseFromParent()
2292  */
2293 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2294
2295 /**
2296  * Obtain the code opcode for an individual instruction.
2297  *
2298  * @see llvm::Instruction::getOpCode()
2299  */
2300 LLVMOpcode   LLVMGetInstructionOpcode(LLVMValueRef Inst);
2301
2302 /**
2303  * Obtain the predicate of an instruction.
2304  *
2305  * This is only valid for instructions that correspond to llvm::ICmpInst
2306  * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2307  *
2308  * @see llvm::ICmpInst::getPredicate()
2309  */
2310 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2311
2312 /**
2313  * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2314  *
2315  * Functions in this group apply to instructions that refer to call
2316  * sites and invocations. These correspond to C++ types in the
2317  * llvm::CallInst class tree.
2318  *
2319  * @{
2320  */
2321
2322 /**
2323  * Set the calling convention for a call instruction.
2324  *
2325  * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2326  * llvm::InvokeInst.
2327  *
2328  * @see llvm::CallInst::setCallingConv()
2329  * @see llvm::InvokeInst::setCallingConv()
2330  */
2331 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2332
2333 /**
2334  * Obtain the calling convention for a call instruction.
2335  *
2336  * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2337  * usage.
2338  *
2339  * @see LLVMSetInstructionCallConv()
2340  */
2341 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2342
2343
2344 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2345 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2346                               LLVMAttribute);
2347 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2348                                 unsigned align);
2349
2350 /**
2351  * Obtain whether a call instruction is a tail call.
2352  *
2353  * This only works on llvm::CallInst instructions.
2354  *
2355  * @see llvm::CallInst::isTailCall()
2356  */
2357 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2358
2359 /**
2360  * Set whether a call instruction is a tail call.
2361  *
2362  * This only works on llvm::CallInst instructions.
2363  *
2364  * @see llvm::CallInst::setTailCall()
2365  */
2366 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2367
2368 /**
2369  * @}
2370  */
2371
2372 /**
2373  * Obtain the default destination basic block of a switch instruction.
2374  *
2375  * This only works on llvm::SwitchInst instructions.
2376  *
2377  * @see llvm::SwitchInst::getDefaultDest()
2378  */
2379 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2380
2381 /**
2382  * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2383  *
2384  * Functions in this group only apply to instructions that map to
2385  * llvm::PHINode instances.
2386  *
2387  * @{
2388  */
2389
2390 /**
2391  * Add an incoming value to the end of a PHI list.
2392  */
2393 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2394                      LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2395
2396 /**
2397  * Obtain the number of incoming basic blocks to a PHI node.
2398  */
2399 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2400
2401 /**
2402  * Obtain an incoming value to a PHI node as an LLVMValueRef.
2403  */
2404 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2405
2406 /**
2407  * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2408  */
2409 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2410
2411 /**
2412  * @}
2413  */
2414
2415 /**
2416  * @}
2417  */
2418
2419 /**
2420  * @}
2421  */
2422
2423 /**
2424  * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2425  *
2426  * An instruction builder represents a point within a basic block and is
2427  * the exclusive means of building instructions using the C interface.
2428  *
2429  * @{
2430  */
2431
2432 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2433 LLVMBuilderRef LLVMCreateBuilder(void);
2434 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2435                          LLVMValueRef Instr);
2436 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2437 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2438 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2439 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2440 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2441 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2442                                    const char *Name);
2443 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2444
2445 /* Metadata */
2446 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2447 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2448 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2449
2450 /* Terminators */
2451 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2452 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2453 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2454                                    unsigned N);
2455 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2456 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2457                              LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2458 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2459                              LLVMBasicBlockRef Else, unsigned NumCases);
2460 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2461                                  unsigned NumDests);
2462 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2463                              LLVMValueRef *Args, unsigned NumArgs,
2464                              LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2465                              const char *Name);
2466 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2467                                  LLVMValueRef PersFn, unsigned NumClauses,
2468                                  const char *Name);
2469 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2470 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2471
2472 /* Add a case to the switch instruction */
2473 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2474                  LLVMBasicBlockRef Dest);
2475
2476 /* Add a destination to the indirectbr instruction */
2477 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2478
2479 /* Add a catch or filter clause to the landingpad instruction */
2480 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2481
2482 /* Set the 'cleanup' flag in the landingpad instruction */
2483 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2484
2485 /* Arithmetic */
2486 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2487                           const char *Name);
2488 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2489                              const char *Name);
2490 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2491                              const char *Name);
2492 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2493                            const char *Name);
2494 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2495                           const char *Name);
2496 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2497                              const char *Name);
2498 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2499                              const char *Name);
2500 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2501                            const char *Name);
2502 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2503                           const char *Name);
2504 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2505                              const char *Name);
2506 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2507                              const char *Name);
2508 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2509                            const char *Name);
2510 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2511                            const char *Name);
2512 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2513                            const char *Name);
2514 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2515                                 const char *Name);
2516 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2517                            const char *Name);
2518 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2519                            const char *Name);
2520 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2521                            const char *Name);
2522 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2523                            const char *Name);
2524 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2525                            const char *Name);
2526 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2527                            const char *Name);
2528 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2529                            const char *Name);
2530 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2531                           const char *Name);
2532 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2533                           const char *Name);
2534 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2535                           const char *Name);
2536 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2537                             LLVMValueRef LHS, LLVMValueRef RHS,
2538                             const char *Name);
2539 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2540 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2541                              const char *Name);
2542 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2543                              const char *Name);
2544 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2545 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2546
2547 /* Memory */
2548 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2549 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2550                                   LLVMValueRef Val, const char *Name);
2551 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2552 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2553                                   LLVMValueRef Val, const char *Name);
2554 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2555 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2556                            const char *Name);
2557 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2558 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2559                           LLVMValueRef *Indices, unsigned NumIndices,
2560                           const char *Name);
2561 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2562                                   LLVMValueRef *Indices, unsigned NumIndices,
2563                                   const char *Name);
2564 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2565                                 unsigned Idx, const char *Name);
2566 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2567                                    const char *Name);
2568 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2569                                       const char *Name);
2570 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2571 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2572
2573 /* Casts */
2574 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2575                             LLVMTypeRef DestTy, const char *Name);
2576 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2577                            LLVMTypeRef DestTy, const char *Name);
2578 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2579                            LLVMTypeRef DestTy, const char *Name);
2580 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2581                              LLVMTypeRef DestTy, const char *Name);
2582 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2583                              LLVMTypeRef DestTy, const char *Name);
2584 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2585                              LLVMTypeRef DestTy, const char *Name);
2586 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2587                              LLVMTypeRef DestTy, const char *Name);
2588 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2589                               LLVMTypeRef DestTy, const char *Name);
2590 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2591                             LLVMTypeRef DestTy, const char *Name);
2592 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2593                                LLVMTypeRef DestTy, const char *Name);
2594 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2595                                LLVMTypeRef DestTy, const char *Name);
2596 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2597                               LLVMTypeRef DestTy, const char *Name);
2598 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2599                                     LLVMTypeRef DestTy, const char *Name);
2600 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2601                                     LLVMTypeRef DestTy, const char *Name);
2602 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2603                                      LLVMTypeRef DestTy, const char *Name);
2604 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2605                            LLVMTypeRef DestTy, const char *Name);
2606 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2607                                   LLVMTypeRef DestTy, const char *Name);
2608 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2609                               LLVMTypeRef DestTy, const char *Name);
2610 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2611                              LLVMTypeRef DestTy, const char *Name);
2612
2613 /* Comparisons */
2614 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2615                            LLVMValueRef LHS, LLVMValueRef RHS,
2616                            const char *Name);
2617 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2618                            LLVMValueRef LHS, LLVMValueRef RHS,
2619                            const char *Name);
2620
2621 /* Miscellaneous instructions */
2622 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2623 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2624                            LLVMValueRef *Args, unsigned NumArgs,
2625                            const char *Name);
2626 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2627                              LLVMValueRef Then, LLVMValueRef Else,
2628                              const char *Name);
2629 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2630                             const char *Name);
2631 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2632                                      LLVMValueRef Index, const char *Name);
2633 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2634                                     LLVMValueRef EltVal, LLVMValueRef Index,
2635                                     const char *Name);
2636 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2637                                     LLVMValueRef V2, LLVMValueRef Mask,
2638                                     const char *Name);
2639 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2640                                    unsigned Index, const char *Name);
2641 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2642                                   LLVMValueRef EltVal, unsigned Index,
2643                                   const char *Name);
2644
2645 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2646                              const char *Name);
2647 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2648                                 const char *Name);
2649 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2650                               LLVMValueRef RHS, const char *Name);
2651 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B,LLVMAtomicRMWBinOp op,
2652                                 LLVMValueRef PTR, LLVMValueRef Val,
2653                                 LLVMAtomicOrdering ordering,
2654                                 LLVMBool singleThread);
2655
2656 /**
2657  * @}
2658  */
2659
2660 /**
2661  * @defgroup LLVMCCoreModuleProvider Module Providers
2662  *
2663  * @{
2664  */
2665
2666 /**
2667  * Changes the type of M so it can be passed to FunctionPassManagers and the
2668  * JIT.  They take ModuleProviders for historical reasons.
2669  */
2670 LLVMModuleProviderRef
2671 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2672
2673 /**
2674  * Destroys the module M.
2675  */
2676 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2677
2678 /**
2679  * @}
2680  */
2681
2682 /**
2683  * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2684  *
2685  * @{
2686  */
2687
2688 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2689                                                   LLVMMemoryBufferRef *OutMemBuf,
2690                                                   char **OutMessage);
2691 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2692                                          char **OutMessage);
2693 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2694                                                           size_t InputDataLength,
2695                                                           const char *BufferName,
2696                                                           LLVMBool RequiresNullTerminator);
2697 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2698                                                               size_t InputDataLength,
2699                                                               const char *BufferName);
2700 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2701 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2702 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2703
2704 /**
2705  * @}
2706  */
2707
2708 /**
2709  * @defgroup LLVMCCorePassRegistry Pass Registry
2710  *
2711  * @{
2712  */
2713
2714 /** Return the global pass registry, for use with initialization functions.
2715     @see llvm::PassRegistry::getPassRegistry */
2716 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2717
2718 /**
2719  * @}
2720  */
2721
2722 /**
2723  * @defgroup LLVMCCorePassManagers Pass Managers
2724  *
2725  * @{
2726  */
2727
2728 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2729     suitable for link-time optimization and whole-module transformations.
2730     @see llvm::PassManager::PassManager */
2731 LLVMPassManagerRef LLVMCreatePassManager(void);
2732
2733 /** Constructs a new function-by-function pass pipeline over the module
2734     provider. It does not take ownership of the module provider. This type of
2735     pipeline is suitable for code generation and JIT compilation tasks.
2736     @see llvm::FunctionPassManager::FunctionPassManager */
2737 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2738
2739 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2740 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2741
2742 /** Initializes, executes on the provided module, and finalizes all of the
2743     passes scheduled in the pass manager. Returns 1 if any of the passes
2744     modified the module, 0 otherwise.
2745     @see llvm::PassManager::run(Module&) */
2746 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2747
2748 /** Initializes all of the function passes scheduled in the function pass
2749     manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2750     @see llvm::FunctionPassManager::doInitialization */
2751 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2752
2753 /** Executes all of the function passes scheduled in the function pass manager
2754     on the provided function. Returns 1 if any of the passes modified the
2755     function, false otherwise.
2756     @see llvm::FunctionPassManager::run(Function&) */
2757 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2758
2759 /** Finalizes all of the function passes scheduled in in the function pass
2760     manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2761     @see llvm::FunctionPassManager::doFinalization */
2762 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2763
2764 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2765     the module provider.
2766     @see llvm::PassManagerBase::~PassManagerBase. */
2767 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2768
2769 /**
2770  * @}
2771  */
2772
2773 /**
2774  * @defgroup LLVMCCoreThreading Threading
2775  *
2776  * Handle the structures needed to make LLVM safe for multithreading.
2777  *
2778  * @{
2779  */
2780
2781 /** Allocate and initialize structures needed to make LLVM safe for
2782     multithreading. The return value indicates whether multithreaded
2783     initialization succeeded. Must be executed in isolation from all
2784     other LLVM api calls.
2785     @see llvm::llvm_start_multithreaded */
2786 LLVMBool LLVMStartMultithreaded(void);
2787
2788 /** Deallocate structures necessary to make LLVM safe for multithreading.
2789     Must be executed in isolation from all other LLVM api calls.
2790     @see llvm::llvm_stop_multithreaded */
2791 void LLVMStopMultithreaded(void);
2792
2793 /** Check whether LLVM is executing in thread-safe mode or not.
2794     @see llvm::llvm_is_multithreaded */
2795 LLVMBool LLVMIsMultithreaded(void);
2796
2797 /**
2798  * @}
2799  */
2800
2801 /**
2802  * @}
2803  */
2804
2805 /**
2806  * @}
2807  */
2808
2809 #ifdef __cplusplus
2810 }
2811 #endif /* !defined(__cplusplus) */
2812
2813 #endif /* !defined(LLVM_C_CORE_H) */