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