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