include/llvm-c/Core.h

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