include/llvm-c/Core.h

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