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 |* LLVM uses a polymorphic type hierarchy which C cannot represent, therefore *|
  14 |* parameters must be passed as base types. Despite the declared types, most  *|
  15 |* of the functions provided operate only on branches of the type hierarchy.  *|
  16 |* The declared parameter names are descriptive and specify which type is     *|
  17 |* required. Additionally, each type hierarchy is documented along with the   *|
  18 |* functions that operate upon it. For more detail, refer to LLVM's C++ code. *|
  19 |* If in doubt, refer to Core.cpp, which performs paramter downcasts in the   *|
  20 |* form unwrap<RequiredType>(Param).                                          *|
  21 |*                                                                            *|
  22 |* Many exotic languages can interoperate with C code but have a harder time  *|
  23 |* with C++ due to name mangling. So in addition to C, this interface enables *|
  24 |* tools written in such languages.                                           *|
  25 |*                                                                            *|
  26 |* When included into a C++ source file, also declares 'wrap' and 'unwrap'    *|
  27 |* helpers to perform opaque reference<-->pointer conversions. These helpers  *|
  28 |* are shorter and more tightly typed than writing the casts by hand when     *|
  29 |* authoring bindings. In assert builds, they will do runtime type checking.  *|
  30 |*                                                                            *|
  31 \*===----------------------------------------------------------------------===*/
  32
  33 #ifndef LLVM_C_CORE_H
  34 #define LLVM_C_CORE_H
  35
  36 #include "llvm/System/DataTypes.h"
  37
  38 #ifdef __cplusplus
  39
  40 /* Need these includes to support the LLVM 'cast' template for the C++ 'wrap'
  41    and 'unwrap' conversion functions. */
  42 #include "llvm/Module.h"
  43 #include "llvm/Support/IRBuilder.h"
  44
  45 extern "C" {
  46 #endif
  47
  48
  49 typedef int LLVMBool;
  50
  51 /* Opaque types. */
  52
  53 /**
  54  * The top-level container for all LLVM global data.  See the LLVMContext class.
  55  */
  56 typedef struct LLVMOpaqueContext *LLVMContextRef;
  57
  58 /**
  59  * The top-level container for all other LLVM Intermediate Representation (IR)
  60  * objects. See the llvm::Module class.
  61  */
  62 typedef struct LLVMOpaqueModule *LLVMModuleRef;
  63
  64 /**
  65  * Each value in the LLVM IR has a type, an LLVMTypeRef. See the llvm::Type
  66  * class.
  67  */
  68 typedef struct LLVMOpaqueType *LLVMTypeRef;
  69
  70 /**
  71  * When building recursive types using LLVMRefineType, LLVMTypeRef values may
  72  * become invalid; use LLVMTypeHandleRef to resolve this problem. See the
  73  * llvm::AbstractTypeHolder class.
  74  */
  75 typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef;
  76
  77 typedef struct LLVMOpaqueValue *LLVMValueRef;
  78 typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
  79 typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
  80
  81 /* Interface used to provide a module to JIT or interpreter.  This is now just a
  82  * synonym for llvm::Module, but we have to keep using the different type to
  83  * keep binary compatibility.
  84  */
  85 typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
  86
  87 /* Used to provide a module to JIT or interpreter.
  88  * See the llvm::MemoryBuffer class.
  89  */
  90 typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
  91
  92 /** See the llvm::PassManagerBase class. */
  93 typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
  94
  95 /**
  96  * Used to iterate through the uses of a Value, allowing access to all Values
  97  * that use this Value.  See the llvm::Use and llvm::value_use_iterator classes.
  98  */
  99 typedef struct LLVMOpaqueUseIterator *LLVMUseIteratorRef;
 100
 101 typedef enum {
 102     LLVMZExtAttribute       = 1<<0,
 103     LLVMSExtAttribute       = 1<<1,
 104     LLVMNoReturnAttribute   = 1<<2,
 105     LLVMInRegAttribute      = 1<<3,
 106     LLVMStructRetAttribute  = 1<<4,
 107     LLVMNoUnwindAttribute   = 1<<5,
 108     LLVMNoAliasAttribute    = 1<<6,
 109     LLVMByValAttribute      = 1<<7,
 110     LLVMNestAttribute       = 1<<8,
 111     LLVMReadNoneAttribute   = 1<<9,
 112     LLVMReadOnlyAttribute   = 1<<10,
 113     LLVMNoInlineAttribute   = 1<<11,
 114     LLVMAlwaysInlineAttribute    = 1<<12,
 115     LLVMOptimizeForSizeAttribute = 1<<13,
 116     LLVMStackProtectAttribute    = 1<<14,
 117     LLVMStackProtectReqAttribute = 1<<15,
 118     LLVMNoCaptureAttribute  = 1<<21,
 119     LLVMNoRedZoneAttribute  = 1<<22,
 120     LLVMNoImplicitFloatAttribute = 1<<23,
 121     LLVMNakedAttribute      = 1<<24,
 122     LLVMInlineHintAttribute = 1<<25
 123 } LLVMAttribute;
 124
 125 typedef enum {
 126   /* Terminator Instructions */
 127   LLVMRet            = 1,
 128   LLVMBr             = 2,
 129   LLVMSwitch         = 3,
 130   LLVMIndirectBr     = 4,
 131   LLVMInvoke         = 5,
 132   LLVMUnwind         = 6,
 133   LLVMUnreachable    = 7,
 134
 135   /* Standard Binary Operators */
 136   LLVMAdd            = 8,
 137   LLVMFAdd           = 9,
 138   LLVMSub            = 10,
 139   LLVMFSub           = 11,
 140   LLVMMul            = 12,
 141   LLVMFMul           = 13,
 142   LLVMUDiv           = 14,
 143   LLVMSDiv           = 15,
 144   LLVMFDiv           = 16,
 145   LLVMURem           = 17,
 146   LLVMSRem           = 18,
 147   LLVMFRem           = 19,
 148
 149   /* Logical Operators */
 150   LLVMShl            = 20,
 151   LLVMLShr           = 21,
 152   LLVMAShr           = 22,
 153   LLVMAnd            = 23,
 154   LLVMOr             = 24,
 155   LLVMXor            = 25,
 156
 157   /* Memory Operators */
 158   LLVMAlloca         = 26,
 159   LLVMLoad           = 27,
 160   LLVMStore          = 28,
 161   LLVMGetElementPtr  = 29,
 162
 163   /* Cast Operators */
 164   LLVMTrunc          = 30,
 165   LLVMZExt           = 31,
 166   LLVMSExt           = 32,
 167   LLVMFPToUI         = 33,
 168   LLVMFPToSI         = 34,
 169   LLVMUIToFP         = 35,
 170   LLVMSIToFP         = 36,
 171   LLVMFPTrunc        = 37,
 172   LLVMFPExt          = 38,
 173   LLVMPtrToInt       = 39,
 174   LLVMIntToPtr       = 40,
 175   LLVMBitCast        = 41,
 176
 177   /* Other Operators */
 178   LLVMICmp           = 42,
 179   LLVMFCmp           = 43,
 180   LLVMPHI            = 44,
 181   LLVMCall           = 45,
 182   LLVMSelect         = 46,
 183   /* UserOp1 */
 184   /* UserOp2 */
 185   LLVMVAArg          = 49,
 186   LLVMExtractElement = 50,
 187   LLVMInsertElement  = 51,
 188   LLVMShuffleVector  = 52,
 189   LLVMExtractValue   = 53,
 190   LLVMInsertValue    = 54
 191 } LLVMOpcode;
 192
 193 typedef enum {
 194   LLVMVoidTypeKind,        /**< type with no size */
 195   LLVMFloatTypeKind,       /**< 32 bit floating point type */
 196   LLVMDoubleTypeKind,      /**< 64 bit floating point type */
 197   LLVMX86_FP80TypeKind,    /**< 80 bit floating point type (X87) */
 198   LLVMFP128TypeKind,       /**< 128 bit floating point type (112-bit mantissa)*/
 199   LLVMPPC_FP128TypeKind,   /**< 128 bit floating point type (two 64-bits) */
 200   LLVMLabelTypeKind,       /**< Labels */
 201   LLVMIntegerTypeKind,     /**< Arbitrary bit width integers */
 202   LLVMFunctionTypeKind,    /**< Functions */
 203   LLVMStructTypeKind,      /**< Structures */
 204   LLVMArrayTypeKind,       /**< Arrays */
 205   LLVMPointerTypeKind,     /**< Pointers */
 206   LLVMOpaqueTypeKind,      /**< Opaque: type with unknown structure */
 207   LLVMVectorTypeKind,      /**< SIMD 'packed' format, or other vector type */
 208   LLVMMetadataTypeKind,    /**< Metadata */
 209   LLVMUnionTypeKind        /**< Unions */
 210 } LLVMTypeKind;
 211
 212 typedef enum {
 213   LLVMExternalLinkage,    /**< Externally visible function */
 214   LLVMAvailableExternallyLinkage,
 215   LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
 216   LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
 217                             equivalent. */
 218   LLVMWeakAnyLinkage,     /**< Keep one copy of function when linking (weak) */
 219   LLVMWeakODRLinkage,     /**< Same, but only replaced by something
 220                             equivalent. */
 221   LLVMAppendingLinkage,   /**< Special purpose, only applies to global arrays */
 222   LLVMInternalLinkage,    /**< Rename collisions when linking (static
 223                                functions) */
 224   LLVMPrivateLinkage,     /**< Like Internal, but omit from symbol table */
 225   LLVMDLLImportLinkage,   /**< Function to be imported from DLL */
 226   LLVMDLLExportLinkage,   /**< Function to be accessible from DLL */
 227   LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
 228   LLVMGhostLinkage,       /**< Obsolete */
 229   LLVMCommonLinkage,      /**< Tentative definitions */
 230   LLVMLinkerPrivateLinkage /**< Like Private, but linker removes. */
 231 } LLVMLinkage;
 232
 233 typedef enum {
 234   LLVMDefaultVisibility,  /**< The GV is visible */
 235   LLVMHiddenVisibility,   /**< The GV is hidden */
 236   LLVMProtectedVisibility /**< The GV is protected */
 237 } LLVMVisibility;
 238
 239 typedef enum {
 240   LLVMCCallConv           = 0,
 241   LLVMFastCallConv        = 8,
 242   LLVMColdCallConv        = 9,
 243   LLVMX86StdcallCallConv  = 64,
 244   LLVMX86FastcallCallConv = 65
 245 } LLVMCallConv;
 246
 247 typedef enum {
 248   LLVMIntEQ = 32, /**< equal */
 249   LLVMIntNE,      /**< not equal */
 250   LLVMIntUGT,     /**< unsigned greater than */
 251   LLVMIntUGE,     /**< unsigned greater or equal */
 252   LLVMIntULT,     /**< unsigned less than */
 253   LLVMIntULE,     /**< unsigned less or equal */
 254   LLVMIntSGT,     /**< signed greater than */
 255   LLVMIntSGE,     /**< signed greater or equal */
 256   LLVMIntSLT,     /**< signed less than */
 257   LLVMIntSLE      /**< signed less or equal */
 258 } LLVMIntPredicate;
 259
 260 typedef enum {
 261   LLVMRealPredicateFalse, /**< Always false (always folded) */
 262   LLVMRealOEQ,            /**< True if ordered and equal */
 263   LLVMRealOGT,            /**< True if ordered and greater than */
 264   LLVMRealOGE,            /**< True if ordered and greater than or equal */
 265   LLVMRealOLT,            /**< True if ordered and less than */
 266   LLVMRealOLE,            /**< True if ordered and less than or equal */
 267   LLVMRealONE,            /**< True if ordered and operands are unequal */
 268   LLVMRealORD,            /**< True if ordered (no nans) */
 269   LLVMRealUNO,            /**< True if unordered: isnan(X) | isnan(Y) */
 270   LLVMRealUEQ,            /**< True if unordered or equal */
 271   LLVMRealUGT,            /**< True if unordered or greater than */
 272   LLVMRealUGE,            /**< True if unordered, greater than, or equal */
 273   LLVMRealULT,            /**< True if unordered or less than */
 274   LLVMRealULE,            /**< True if unordered, less than, or equal */
 275   LLVMRealUNE,            /**< True if unordered or not equal */
 276   LLVMRealPredicateTrue   /**< Always true (always folded) */
 277 } LLVMRealPredicate;
 278
 279
 280 /*===-- Error handling ----------------------------------------------------===*/
 281
 282 void LLVMDisposeMessage(char *Message);
 283
 284
 285 /*===-- Modules -----------------------------------------------------------===*/
 286
 287 /* Create and destroy contexts. */
 288 LLVMContextRef LLVMContextCreate(void);
 289 LLVMContextRef LLVMGetGlobalContext(void);
 290 void LLVMContextDispose(LLVMContextRef C);
 291
 292 /* Create and destroy modules. */
 293 /** See llvm::Module::Module. */
 294 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
 295 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
 296                                                 LLVMContextRef C);
 297
 298 /** See llvm::Module::~Module. */
 299 void LLVMDisposeModule(LLVMModuleRef M);
 300
 301 /** Data layout. See Module::getDataLayout. */
 302 const char *LLVMGetDataLayout(LLVMModuleRef M);
 303 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
 304
 305 /** Target triple. See Module::getTargetTriple. */
 306 const char *LLVMGetTarget(LLVMModuleRef M);
 307 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
 308
 309 /** See Module::addTypeName. */
 310 LLVMBool LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
 311 void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
 312 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
 313
 314 /** See Module::dump. */
 315 void LLVMDumpModule(LLVMModuleRef M);
 316
 317
 318 /*===-- Types -------------------------------------------------------------===*/
 319
 320 /* LLVM types conform to the following hierarchy:
 321  *
 322  *   types:
 323  *     integer type
 324  *     real type
 325  *     function type
 326  *     sequence types:
 327  *       array type
 328  *       pointer type
 329  *       vector type
 330  *     void type
 331  *     label type
 332  *     opaque type
 333  */
 334
 335 /** See llvm::LLVMTypeKind::getTypeID. */
 336 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
 337
 338 /** See llvm::LLVMType::getContext. */
 339 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
 340
 341 /* Operations on integer types */
 342 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
 343 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
 344 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
 345 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
 346 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
 347 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
 348
 349 LLVMTypeRef LLVMInt1Type(void);
 350 LLVMTypeRef LLVMInt8Type(void);
 351 LLVMTypeRef LLVMInt16Type(void);
 352 LLVMTypeRef LLVMInt32Type(void);
 353 LLVMTypeRef LLVMInt64Type(void);
 354 LLVMTypeRef LLVMIntType(unsigned NumBits);
 355 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
 356
 357 /* Operations on real types */
 358 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
 359 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
 360 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
 361 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
 362 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
 363
 364 LLVMTypeRef LLVMFloatType(void);
 365 LLVMTypeRef LLVMDoubleType(void);
 366 LLVMTypeRef LLVMX86FP80Type(void);
 367 LLVMTypeRef LLVMFP128Type(void);
 368 LLVMTypeRef LLVMPPCFP128Type(void);
 369
 370 /* Operations on function types */
 371 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
 372                              LLVMTypeRef *ParamTypes, unsigned ParamCount,
 373                              LLVMBool IsVarArg);
 374 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
 375 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
 376 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
 377 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
 378
 379 /* Operations on struct types */
 380 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
 381                                     unsigned ElementCount, LLVMBool Packed);
 382 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
 383                            LLVMBool Packed);
 384 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
 385 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
 386 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
 387
 388 /* Operations on union types */
 389 LLVMTypeRef LLVMUnionTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
 390                                    unsigned ElementCount);
 391 LLVMTypeRef LLVMUnionType(LLVMTypeRef *ElementTypes, unsigned ElementCount);
 392 unsigned LLVMCountUnionElementTypes(LLVMTypeRef UnionTy);
 393 void LLVMGetUnionElementTypes(LLVMTypeRef UnionTy, LLVMTypeRef *Dest);
 394
 395 /* Operations on array, pointer, and vector types (sequence types) */
 396 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
 397 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
 398 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
 399
 400 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
 401 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
 402 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
 403 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
 404
 405 /* Operations on other types */
 406 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
 407 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
 408 LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
 409
 410 LLVMTypeRef LLVMVoidType(void);
 411 LLVMTypeRef LLVMLabelType(void);
 412 LLVMTypeRef LLVMOpaqueType(void);
 413
 414 /* Operations on type handles */
 415 LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
 416 void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
 417 LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
 418 void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
 419
 420
 421 /*===-- Values ------------------------------------------------------------===*/
 422
 423 /* The bulk of LLVM's object model consists of values, which comprise a very
 424  * rich type hierarchy.
 425  */
 426
 427 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
 428   macro(Argument)                           \
 429   macro(BasicBlock)                         \
 430   macro(InlineAsm)                          \
 431   macro(User)                               \
 432     macro(Constant)                         \
 433       macro(ConstantAggregateZero)          \
 434       macro(ConstantArray)                  \
 435       macro(ConstantExpr)                   \
 436       macro(ConstantFP)                     \
 437       macro(ConstantInt)                    \
 438       macro(ConstantPointerNull)            \
 439       macro(ConstantStruct)                 \
 440       macro(ConstantVector)                 \
 441       macro(GlobalValue)                    \
 442         macro(Function)                     \
 443         macro(GlobalAlias)                  \
 444         macro(GlobalVariable)               \
 445       macro(UndefValue)                     \
 446     macro(Instruction)                      \
 447       macro(BinaryOperator)                 \
 448       macro(CallInst)                       \
 449         macro(IntrinsicInst)                \
 450           macro(DbgInfoIntrinsic)           \
 451             macro(DbgDeclareInst)           \
 452           macro(EHSelectorInst)             \
 453           macro(MemIntrinsic)               \
 454             macro(MemCpyInst)               \
 455             macro(MemMoveInst)              \
 456             macro(MemSetInst)               \
 457       macro(CmpInst)                        \
 458       macro(FCmpInst)                       \
 459       macro(ICmpInst)                       \
 460       macro(ExtractElementInst)             \
 461       macro(GetElementPtrInst)              \
 462       macro(InsertElementInst)              \
 463       macro(InsertValueInst)                \
 464       macro(PHINode)                        \
 465       macro(SelectInst)                     \
 466       macro(ShuffleVectorInst)              \
 467       macro(StoreInst)                      \
 468       macro(TerminatorInst)                 \
 469         macro(BranchInst)                   \
 470         macro(InvokeInst)                   \
 471         macro(ReturnInst)                   \
 472         macro(SwitchInst)                   \
 473         macro(UnreachableInst)              \
 474         macro(UnwindInst)                   \
 475     macro(UnaryInstruction)                 \
 476       macro(AllocaInst)                     \
 477       macro(CastInst)                       \
 478         macro(BitCastInst)                  \
 479         macro(FPExtInst)                    \
 480         macro(FPToSIInst)                   \
 481         macro(FPToUIInst)                   \
 482         macro(FPTruncInst)                  \
 483         macro(IntToPtrInst)                 \
 484         macro(PtrToIntInst)                 \
 485         macro(SExtInst)                     \
 486         macro(SIToFPInst)                   \
 487         macro(TruncInst)                    \
 488         macro(UIToFPInst)                   \
 489         macro(ZExtInst)                     \
 490       macro(ExtractValueInst)               \
 491       macro(LoadInst)                       \
 492       macro(VAArgInst)
 493
 494 /* Operations on all values */
 495 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
 496 const char *LLVMGetValueName(LLVMValueRef Val);
 497 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
 498 void LLVMDumpValue(LLVMValueRef Val);
 499 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
 500
 501 /* Conversion functions. Return the input value if it is an instance of the
 502    specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
 503 #define LLVM_DECLARE_VALUE_CAST(name) \
 504   LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
 505 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
 506
 507 /* Operations on Uses */
 508 LLVMUseIteratorRef LLVMGetFirstUse(LLVMValueRef Val);
 509 LLVMUseIteratorRef LLVMGetNextUse(LLVMUseIteratorRef U);
 510 LLVMValueRef LLVMGetUser(LLVMUseIteratorRef U);
 511 LLVMValueRef LLVMGetUsedValue(LLVMUseIteratorRef U);
 512
 513 /* Operations on Users */
 514 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
 515
 516 /* Operations on constants of any type */
 517 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
 518 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
 519 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
 520 LLVMBool LLVMIsConstant(LLVMValueRef Val);
 521 LLVMBool LLVMIsNull(LLVMValueRef Val);
 522 LLVMBool LLVMIsUndef(LLVMValueRef Val);
 523 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
 524
 525 /* Operations on scalar constants */
 526 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
 527                           LLVMBool SignExtend);
 528 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
 529                                   uint8_t Radix);
 530 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
 531                                          unsigned SLen, uint8_t Radix);
 532 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
 533 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
 534 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
 535                                           unsigned SLen);
 536 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
 537 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
 538
 539
 540 /* Operations on composite constants */
 541 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
 542                                       unsigned Length, LLVMBool DontNullTerminate);
 543 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
 544                                       LLVMValueRef *ConstantVals,
 545                                       unsigned Count, LLVMBool Packed);
 546
 547 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
 548                              LLVMBool DontNullTerminate);
 549 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
 550                             LLVMValueRef *ConstantVals, unsigned Length);
 551 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
 552                              LLVMBool Packed);
 553 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
 554 LLVMValueRef LLVMConstUnion(LLVMTypeRef Ty, LLVMValueRef Val);
 555
 556 /* Constant expressions */
 557 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
 558 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
 559 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
 560 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
 561 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
 562 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
 563 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
 564 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
 565 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 566 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 567 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 568 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 569 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 570 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 571 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 572 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 573 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 574 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 575 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 576 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 577 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 578 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 579 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 580 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 581 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 582 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 583 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 584 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 585 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 586 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 587 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
 588                            LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 589 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
 590                            LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 591 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 592 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 593 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 594 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
 595                           LLVMValueRef *ConstantIndices, unsigned NumIndices);
 596 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
 597                                   LLVMValueRef *ConstantIndices,
 598                                   unsigned NumIndices);
 599 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 600 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 601 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 602 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 603 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 604 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 605 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 606 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 607 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 608 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 609 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 610 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 611 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
 612                                     LLVMTypeRef ToType);
 613 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
 614                                     LLVMTypeRef ToType);
 615 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
 616                                      LLVMTypeRef ToType);
 617 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
 618                                   LLVMTypeRef ToType);
 619 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
 620                               LLVMBool isSigned);
 621 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 622 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
 623                              LLVMValueRef ConstantIfTrue,
 624                              LLVMValueRef ConstantIfFalse);
 625 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
 626                                      LLVMValueRef IndexConstant);
 627 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
 628                                     LLVMValueRef ElementValueConstant,
 629                                     LLVMValueRef IndexConstant);
 630 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
 631                                     LLVMValueRef VectorBConstant,
 632                                     LLVMValueRef MaskConstant);
 633 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
 634                                    unsigned NumIdx);
 635 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
 636                                   LLVMValueRef ElementValueConstant,
 637                                   unsigned *IdxList, unsigned NumIdx);
 638 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
 639                                 const char *AsmString, const char *Constraints,
 640                                 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
 641
 642 /* Operations on global variables, functions, and aliases (globals) */
 643 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
 644 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
 645 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
 646 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
 647 const char *LLVMGetSection(LLVMValueRef Global);
 648 void LLVMSetSection(LLVMValueRef Global, const char *Section);
 649 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
 650 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
 651 unsigned LLVMGetAlignment(LLVMValueRef Global);
 652 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
 653
 654 /* Operations on global variables */
 655 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
 656 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
 657 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
 658 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
 659 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
 660 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
 661 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
 662 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
 663 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
 664 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
 665 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
 666 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
 667 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
 668
 669 /* Operations on aliases */
 670 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
 671                           const char *Name);
 672
 673 /* Operations on functions */
 674 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
 675                              LLVMTypeRef FunctionTy);
 676 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
 677 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
 678 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
 679 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
 680 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
 681 void LLVMDeleteFunction(LLVMValueRef Fn);
 682 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
 683 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
 684 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
 685 const char *LLVMGetGC(LLVMValueRef Fn);
 686 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
 687 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
 688 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
 689 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
 690
 691 /* Operations on parameters */
 692 unsigned LLVMCountParams(LLVMValueRef Fn);
 693 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
 694 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
 695 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
 696 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
 697 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
 698 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
 699 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
 700 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
 701 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
 702 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
 703 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
 704
 705 /* Operations on basic blocks */
 706 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
 707 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
 708 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
 709 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
 710 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
 711 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
 712 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
 713 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
 714 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
 715 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
 716 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
 717
 718 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
 719                                                 LLVMValueRef Fn,
 720                                                 const char *Name);
 721 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
 722                                                 LLVMBasicBlockRef BB,
 723                                                 const char *Name);
 724
 725 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
 726 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
 727                                        const char *Name);
 728 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
 729
 730 /* Operations on instructions */
 731 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
 732 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
 733 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
 734 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
 735 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
 736
 737 /* Operations on call sites */
 738 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
 739 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
 740 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
 741 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
 742                               LLVMAttribute);
 743 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
 744                                 unsigned align);
 745
 746 /* Operations on call instructions (only) */
 747 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
 748 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
 749
 750 /* Operations on phi nodes */
 751 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
 752                      LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
 753 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
 754 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
 755 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
 756
 757 /*===-- Instruction builders ----------------------------------------------===*/
 758
 759 /* An instruction builder represents a point within a basic block, and is the
 760  * exclusive means of building instructions using the C interface.
 761  */
 762
 763 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
 764 LLVMBuilderRef LLVMCreateBuilder(void);
 765 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
 766                          LLVMValueRef Instr);
 767 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
 768 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
 769 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
 770 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
 771 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
 772 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
 773                                    const char *Name);
 774 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
 775
 776 /* Terminators */
 777 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
 778 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
 779 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
 780                                    unsigned N);
 781 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
 782 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
 783                              LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
 784 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
 785                              LLVMBasicBlockRef Else, unsigned NumCases);
 786 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
 787                              LLVMValueRef *Args, unsigned NumArgs,
 788                              LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
 789                              const char *Name);
 790 LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
 791 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
 792
 793 /* Add a case to the switch instruction */
 794 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
 795                  LLVMBasicBlockRef Dest);
 796
 797 /* Arithmetic */
 798 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 799                           const char *Name);
 800 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 801                              const char *Name);
 802 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 803                              const char *Name);
 804 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 805                            const char *Name);
 806 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 807                           const char *Name);
 808 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 809                              const char *Name);
 810 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 811                              const char *Name);
 812 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 813                            const char *Name);
 814 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 815                           const char *Name);
 816 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 817                              const char *Name);
 818 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 819                              const char *Name);
 820 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 821                            const char *Name);
 822 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 823                            const char *Name);
 824 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 825                            const char *Name);
 826 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 827                                 const char *Name);
 828 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 829                            const char *Name);
 830 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 831                            const char *Name);
 832 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 833                            const char *Name);
 834 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 835                            const char *Name);
 836 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 837                            const char *Name);
 838 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 839                            const char *Name);
 840 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 841                            const char *Name);
 842 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 843                           const char *Name);
 844 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 845                           const char *Name);
 846 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 847                           const char *Name);
 848 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
 849                             LLVMValueRef LHS, LLVMValueRef RHS,
 850                             const char *Name);
 851 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
 852 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
 853                              const char *Name);
 854 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
 855                              const char *Name);
 856 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
 857 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
 858
 859 /* Memory */
 860 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
 861 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
 862                                   LLVMValueRef Val, const char *Name);
 863 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
 864 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
 865                                   LLVMValueRef Val, const char *Name);
 866 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
 867 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
 868                            const char *Name);
 869 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
 870 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
 871                           LLVMValueRef *Indices, unsigned NumIndices,
 872                           const char *Name);
 873 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
 874                                   LLVMValueRef *Indices, unsigned NumIndices,
 875                                   const char *Name);
 876 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
 877                                 unsigned Idx, const char *Name);
 878 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
 879                                    const char *Name);
 880 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
 881                                       const char *Name);
 882
 883 /* Casts */
 884 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
 885                             LLVMTypeRef DestTy, const char *Name);
 886 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
 887                            LLVMTypeRef DestTy, const char *Name);
 888 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
 889                            LLVMTypeRef DestTy, const char *Name);
 890 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
 891                              LLVMTypeRef DestTy, const char *Name);
 892 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
 893                              LLVMTypeRef DestTy, const char *Name);
 894 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
 895                              LLVMTypeRef DestTy, const char *Name);
 896 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
 897                              LLVMTypeRef DestTy, const char *Name);
 898 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
 899                               LLVMTypeRef DestTy, const char *Name);
 900 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
 901                             LLVMTypeRef DestTy, const char *Name);
 902 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
 903                                LLVMTypeRef DestTy, const char *Name);
 904 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
 905                                LLVMTypeRef DestTy, const char *Name);
 906 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
 907                               LLVMTypeRef DestTy, const char *Name);
 908 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
 909                                     LLVMTypeRef DestTy, const char *Name);
 910 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
 911                                     LLVMTypeRef DestTy, const char *Name);
 912 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
 913                                      LLVMTypeRef DestTy, const char *Name);
 914 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
 915                            LLVMTypeRef DestTy, const char *Name);
 916 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
 917                                   LLVMTypeRef DestTy, const char *Name);
 918 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
 919                               LLVMTypeRef DestTy, const char *Name);
 920 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
 921                              LLVMTypeRef DestTy, const char *Name);
 922
 923 /* Comparisons */
 924 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
 925                            LLVMValueRef LHS, LLVMValueRef RHS,
 926                            const char *Name);
 927 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
 928                            LLVMValueRef LHS, LLVMValueRef RHS,
 929                            const char *Name);
 930
 931 /* Miscellaneous instructions */
 932 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
 933 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
 934                            LLVMValueRef *Args, unsigned NumArgs,
 935                            const char *Name);
 936 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
 937                              LLVMValueRef Then, LLVMValueRef Else,
 938                              const char *Name);
 939 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
 940                             const char *Name);
 941 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
 942                                      LLVMValueRef Index, const char *Name);
 943 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
 944                                     LLVMValueRef EltVal, LLVMValueRef Index,
 945                                     const char *Name);
 946 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
 947                                     LLVMValueRef V2, LLVMValueRef Mask,
 948                                     const char *Name);
 949 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
 950                                    unsigned Index, const char *Name);
 951 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
 952                                   LLVMValueRef EltVal, unsigned Index,
 953                                   const char *Name);
 954
 955 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
 956                              const char *Name);
 957 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
 958                                 const char *Name);
 959 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
 960                               LLVMValueRef RHS, const char *Name);
 961
 962
 963 /*===-- Module providers --------------------------------------------------===*/
 964
 965 /* Changes the type of M so it can be passed to FunctionPassManagers and the
 966  * JIT.  They take ModuleProviders for historical reasons.
 967  */
 968 LLVMModuleProviderRef
 969 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
 970
 971 /* Destroys the module M.
 972  */
 973 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
 974
 975
 976 /*===-- Memory buffers ----------------------------------------------------===*/
 977
 978 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
 979                                                   LLVMMemoryBufferRef *OutMemBuf,
 980                                                   char **OutMessage);
 981 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
 982                                          char **OutMessage);
 983 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
 984
 985
 986 /*===-- Pass Managers -----------------------------------------------------===*/
 987
 988 /** Constructs a new whole-module pass pipeline. This type of pipeline is
 989     suitable for link-time optimization and whole-module transformations.
 990     See llvm::PassManager::PassManager. */
 991 LLVMPassManagerRef LLVMCreatePassManager(void);
 992
 993 /** Constructs a new function-by-function pass pipeline over the module
 994     provider. It does not take ownership of the module provider. This type of
 995     pipeline is suitable for code generation and JIT compilation tasks.
 996     See llvm::FunctionPassManager::FunctionPassManager. */
 997 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
 998
 999 /** Initializes, executes on the provided module, and finalizes all of the
1000     passes scheduled in the pass manager. Returns 1 if any of the passes
1001     modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
1002 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
1003
1004 /** Initializes all of the function passes scheduled in the function pass
1005     manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1006     See llvm::FunctionPassManager::doInitialization. */
1007 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
1008
1009 /** Executes all of the function passes scheduled in the function pass manager
1010     on the provided function. Returns 1 if any of the passes modified the
1011     function, false otherwise.
1012     See llvm::FunctionPassManager::run(Function&). */
1013 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
1014
1015 /** Finalizes all of the function passes scheduled in in the function pass
1016     manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1017     See llvm::FunctionPassManager::doFinalization. */
1018 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
1019
1020 /** Frees the memory of a pass pipeline. For function pipelines, does not free
1021     the module provider.
1022     See llvm::PassManagerBase::~PassManagerBase. */
1023 void LLVMDisposePassManager(LLVMPassManagerRef PM);
1024
1025
1026 #ifdef __cplusplus
1027 }
1028
1029 namespace llvm {
1030   class MemoryBuffer;
1031   class PassManagerBase;
1032
1033   #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)   \
1034     inline ty *unwrap(ref P) {                          \
1035       return reinterpret_cast<ty*>(P);                  \
1036     }                                                   \
1037                                                         \
1038     inline ref wrap(const ty *P) {                      \
1039       return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1040     }
1041
1042   #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref)  \
1043     DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)         \
1044                                                         \
1045     template<typename T>                                \
1046     inline T *unwrap(ref P) {                           \
1047       return cast<T>(unwrap(P));                        \
1048     }
1049
1050   #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref)   \
1051     DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)         \
1052                                                         \
1053     template<typename T>                                \
1054     inline T *unwrap(ref P) {                           \
1055       T *Q = (T*)unwrap(P);                             \
1056       assert(Q && "Invalid cast!");                     \
1057       return Q;                                         \
1058     }
1059
1060   DEFINE_ISA_CONVERSION_FUNCTIONS   (Type,               LLVMTypeRef          )
1061   DEFINE_ISA_CONVERSION_FUNCTIONS   (Value,              LLVMValueRef         )
1062   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module,             LLVMModuleRef        )
1063   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock,         LLVMBasicBlockRef    )
1064   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>,        LLVMBuilderRef       )
1065   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder,       LLVMTypeHandleRef    )
1066   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer,       LLVMMemoryBufferRef  )
1067   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext,        LLVMContextRef       )
1068   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use,                LLVMUseIteratorRef           )
1069   DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase,    LLVMPassManagerRef   )
1070   /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1071    * Module.
1072    */
1073   inline Module *unwrap(LLVMModuleProviderRef MP) {
1074     return reinterpret_cast<Module*>(MP);
1075   }
1076
1077   #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1078   #undef DEFINE_ISA_CONVERSION_FUNCTIONS
1079   #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
1080
1081   /* Specialized opaque context conversions.
1082    */
1083   inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1084     return reinterpret_cast<LLVMContext**>(Tys);
1085   }
1086
1087   inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1088     return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1089   }
1090
1091   /* Specialized opaque type conversions.
1092    */
1093   inline Type **unwrap(LLVMTypeRef* Tys) {
1094     return reinterpret_cast<Type**>(Tys);
1095   }
1096
1097   inline LLVMTypeRef *wrap(const Type **Tys) {
1098     return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1099   }
1100
1101   /* Specialized opaque value conversions.
1102    */
1103   inline Value **unwrap(LLVMValueRef *Vals) {
1104     return reinterpret_cast<Value**>(Vals);
1105   }
1106
1107   template<typename T>
1108   inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1109     #if DEBUG
1110     for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
1111       cast<T>(*I);
1112     #endif
1113     return reinterpret_cast<T**>(Vals);
1114   }
1115
1116   inline LLVMValueRef *wrap(const Value **Vals) {
1117     return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1118   }
1119 }
1120
1121 #endif /* !defined(__cplusplus) */
1122
1123 #endif /* !defined(LLVM_C_CORE_H) */