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