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