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