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 /*===-- Contexts ----------------------------------------------------------===*/
 286
 287 /* Create and destroy contexts. */
 288 LLVMContextRef LLVMContextCreate(void);
 289 LLVMContextRef LLVMGetGlobalContext(void);
 290 void LLVMContextDispose(LLVMContextRef C);
 291
 292 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
 293                                   unsigned SLen);
 294 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
 295
 296 /*===-- Modules -----------------------------------------------------------===*/
 297
 298 /* Create and destroy modules. */
 299 /** See llvm::Module::Module. */
 300 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
 301 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
 302                                                 LLVMContextRef C);
 303
 304 /** See llvm::Module::~Module. */
 305 void LLVMDisposeModule(LLVMModuleRef M);
 306
 307 /** Data layout. See Module::getDataLayout. */
 308 const char *LLVMGetDataLayout(LLVMModuleRef M);
 309 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
 310
 311 /** Target triple. See Module::getTargetTriple. */
 312 const char *LLVMGetTarget(LLVMModuleRef M);
 313 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
 314
 315 /** See Module::addTypeName. */
 316 LLVMBool LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
 317 void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
 318 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
 319
 320 /** See Module::dump. */
 321 void LLVMDumpModule(LLVMModuleRef M);
 322
 323
 324 /*===-- Types -------------------------------------------------------------===*/
 325
 326 /* LLVM types conform to the following hierarchy:
 327  *
 328  *   types:
 329  *     integer type
 330  *     real type
 331  *     function type
 332  *     sequence types:
 333  *       array type
 334  *       pointer type
 335  *       vector type
 336  *     void type
 337  *     label type
 338  *     opaque type
 339  */
 340
 341 /** See llvm::LLVMTypeKind::getTypeID. */
 342 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
 343
 344 /** See llvm::LLVMType::getContext. */
 345 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
 346
 347 /* Operations on integer types */
 348 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
 349 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
 350 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
 351 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
 352 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
 353 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
 354
 355 LLVMTypeRef LLVMInt1Type(void);
 356 LLVMTypeRef LLVMInt8Type(void);
 357 LLVMTypeRef LLVMInt16Type(void);
 358 LLVMTypeRef LLVMInt32Type(void);
 359 LLVMTypeRef LLVMInt64Type(void);
 360 LLVMTypeRef LLVMIntType(unsigned NumBits);
 361 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
 362
 363 /* Operations on real types */
 364 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
 365 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
 366 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
 367 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
 368 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
 369
 370 LLVMTypeRef LLVMFloatType(void);
 371 LLVMTypeRef LLVMDoubleType(void);
 372 LLVMTypeRef LLVMX86FP80Type(void);
 373 LLVMTypeRef LLVMFP128Type(void);
 374 LLVMTypeRef LLVMPPCFP128Type(void);
 375
 376 /* Operations on function types */
 377 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
 378                              LLVMTypeRef *ParamTypes, unsigned ParamCount,
 379                              LLVMBool IsVarArg);
 380 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
 381 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
 382 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
 383 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
 384
 385 /* Operations on struct types */
 386 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
 387                                     unsigned ElementCount, LLVMBool Packed);
 388 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
 389                            LLVMBool Packed);
 390 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
 391 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
 392 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
 393
 394 /* Operations on union types */
 395 LLVMTypeRef LLVMUnionTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
 396                                    unsigned ElementCount);
 397 LLVMTypeRef LLVMUnionType(LLVMTypeRef *ElementTypes, unsigned ElementCount);
 398 unsigned LLVMCountUnionElementTypes(LLVMTypeRef UnionTy);
 399 void LLVMGetUnionElementTypes(LLVMTypeRef UnionTy, LLVMTypeRef *Dest);
 400
 401 /* Operations on array, pointer, and vector types (sequence types) */
 402 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
 403 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
 404 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
 405
 406 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
 407 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
 408 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
 409 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
 410
 411 /* Operations on other types */
 412 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
 413 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
 414 LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
 415
 416 LLVMTypeRef LLVMVoidType(void);
 417 LLVMTypeRef LLVMLabelType(void);
 418 LLVMTypeRef LLVMOpaqueType(void);
 419
 420 /* Operations on type handles */
 421 LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
 422 void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
 423 LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
 424 void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
 425
 426
 427 /*===-- Values ------------------------------------------------------------===*/
 428
 429 /* The bulk of LLVM's object model consists of values, which comprise a very
 430  * rich type hierarchy.
 431  */
 432
 433 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
 434   macro(Argument)                           \
 435   macro(BasicBlock)                         \
 436   macro(InlineAsm)                          \
 437   macro(User)                               \
 438     macro(Constant)                         \
 439       macro(ConstantAggregateZero)          \
 440       macro(ConstantArray)                  \
 441       macro(ConstantExpr)                   \
 442       macro(ConstantFP)                     \
 443       macro(ConstantInt)                    \
 444       macro(ConstantPointerNull)            \
 445       macro(ConstantStruct)                 \
 446       macro(ConstantVector)                 \
 447       macro(GlobalValue)                    \
 448         macro(Function)                     \
 449         macro(GlobalAlias)                  \
 450         macro(GlobalVariable)               \
 451       macro(UndefValue)                     \
 452     macro(Instruction)                      \
 453       macro(BinaryOperator)                 \
 454       macro(CallInst)                       \
 455         macro(IntrinsicInst)                \
 456           macro(DbgInfoIntrinsic)           \
 457             macro(DbgDeclareInst)           \
 458           macro(EHSelectorInst)             \
 459           macro(MemIntrinsic)               \
 460             macro(MemCpyInst)               \
 461             macro(MemMoveInst)              \
 462             macro(MemSetInst)               \
 463       macro(CmpInst)                        \
 464       macro(FCmpInst)                       \
 465       macro(ICmpInst)                       \
 466       macro(ExtractElementInst)             \
 467       macro(GetElementPtrInst)              \
 468       macro(InsertElementInst)              \
 469       macro(InsertValueInst)                \
 470       macro(PHINode)                        \
 471       macro(SelectInst)                     \
 472       macro(ShuffleVectorInst)              \
 473       macro(StoreInst)                      \
 474       macro(TerminatorInst)                 \
 475         macro(BranchInst)                   \
 476         macro(InvokeInst)                   \
 477         macro(ReturnInst)                   \
 478         macro(SwitchInst)                   \
 479         macro(UnreachableInst)              \
 480         macro(UnwindInst)                   \
 481     macro(UnaryInstruction)                 \
 482       macro(AllocaInst)                     \
 483       macro(CastInst)                       \
 484         macro(BitCastInst)                  \
 485         macro(FPExtInst)                    \
 486         macro(FPToSIInst)                   \
 487         macro(FPToUIInst)                   \
 488         macro(FPTruncInst)                  \
 489         macro(IntToPtrInst)                 \
 490         macro(PtrToIntInst)                 \
 491         macro(SExtInst)                     \
 492         macro(SIToFPInst)                   \
 493         macro(TruncInst)                    \
 494         macro(UIToFPInst)                   \
 495         macro(ZExtInst)                     \
 496       macro(ExtractValueInst)               \
 497       macro(LoadInst)                       \
 498       macro(VAArgInst)
 499
 500 /* Operations on all values */
 501 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
 502 const char *LLVMGetValueName(LLVMValueRef Val);
 503 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
 504 void LLVMDumpValue(LLVMValueRef Val);
 505 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
 506 int LLVMHasMetadata(LLVMValueRef Val);
 507 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
 508 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
 509
 510 /* Conversion functions. Return the input value if it is an instance of the
 511    specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
 512 #define LLVM_DECLARE_VALUE_CAST(name) \
 513   LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
 514 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
 515
 516 /* Operations on Uses */
 517 LLVMUseIteratorRef LLVMGetFirstUse(LLVMValueRef Val);
 518 LLVMUseIteratorRef LLVMGetNextUse(LLVMUseIteratorRef U);
 519 LLVMValueRef LLVMGetUser(LLVMUseIteratorRef U);
 520 LLVMValueRef LLVMGetUsedValue(LLVMUseIteratorRef U);
 521
 522 /* Operations on Users */
 523 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
 524
 525 /* Operations on constants of any type */
 526 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
 527 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
 528 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
 529 LLVMBool LLVMIsConstant(LLVMValueRef Val);
 530 LLVMBool LLVMIsNull(LLVMValueRef Val);
 531 LLVMBool LLVMIsUndef(LLVMValueRef Val);
 532 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
 533
 534 /* Operations on metadata */
 535 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
 536                                    unsigned SLen);
 537 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
 538 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
 539                                  unsigned Count);
 540 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
 541
 542 /* Operations on scalar constants */
 543 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
 544                           LLVMBool SignExtend);
 545 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
 546                                   uint8_t Radix);
 547 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
 548                                          unsigned SLen, uint8_t Radix);
 549 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
 550 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
 551 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
 552                                           unsigned SLen);
 553 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
 554 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
 555
 556
 557 /* Operations on composite constants */
 558 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
 559                                       unsigned Length, LLVMBool DontNullTerminate);
 560 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
 561                                       LLVMValueRef *ConstantVals,
 562                                       unsigned Count, LLVMBool Packed);
 563
 564 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
 565                              LLVMBool DontNullTerminate);
 566 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
 567                             LLVMValueRef *ConstantVals, unsigned Length);
 568 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
 569                              LLVMBool Packed);
 570 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
 571 LLVMValueRef LLVMConstUnion(LLVMTypeRef Ty, LLVMValueRef Val);
 572
 573 /* Constant expressions */
 574 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
 575 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
 576 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
 577 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
 578 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
 579 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
 580 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
 581 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
 582 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 583 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 584 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 585 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 586 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 587 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 588 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 589 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 590 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 591 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 592 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 593 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 594 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 595 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 596 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 597 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 598 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 599 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 600 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 601 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 602 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 603 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 604 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
 605                            LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 606 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
 607                            LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 608 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 609 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 610 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
 611 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
 612                           LLVMValueRef *ConstantIndices, unsigned NumIndices);
 613 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
 614                                   LLVMValueRef *ConstantIndices,
 615                                   unsigned NumIndices);
 616 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 617 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 618 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 619 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 620 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 621 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 622 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 623 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 624 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 625 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 626 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 627 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 628 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
 629                                     LLVMTypeRef ToType);
 630 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
 631                                     LLVMTypeRef ToType);
 632 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
 633                                      LLVMTypeRef ToType);
 634 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
 635                                   LLVMTypeRef ToType);
 636 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
 637                               LLVMBool isSigned);
 638 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
 639 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
 640                              LLVMValueRef ConstantIfTrue,
 641                              LLVMValueRef ConstantIfFalse);
 642 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
 643                                      LLVMValueRef IndexConstant);
 644 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
 645                                     LLVMValueRef ElementValueConstant,
 646                                     LLVMValueRef IndexConstant);
 647 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
 648                                     LLVMValueRef VectorBConstant,
 649                                     LLVMValueRef MaskConstant);
 650 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
 651                                    unsigned NumIdx);
 652 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
 653                                   LLVMValueRef ElementValueConstant,
 654                                   unsigned *IdxList, unsigned NumIdx);
 655 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
 656                                 const char *AsmString, const char *Constraints,
 657                                 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
 658
 659 /* Operations on global variables, functions, and aliases (globals) */
 660 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
 661 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
 662 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
 663 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
 664 const char *LLVMGetSection(LLVMValueRef Global);
 665 void LLVMSetSection(LLVMValueRef Global, const char *Section);
 666 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
 667 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
 668 unsigned LLVMGetAlignment(LLVMValueRef Global);
 669 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
 670
 671 /* Operations on global variables */
 672 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
 673 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
 674 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
 675 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
 676 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
 677 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
 678 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
 679 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
 680 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
 681 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
 682 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
 683 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
 684 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
 685
 686 /* Operations on aliases */
 687 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
 688                           const char *Name);
 689
 690 /* Operations on functions */
 691 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
 692                              LLVMTypeRef FunctionTy);
 693 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
 694 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
 695 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
 696 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
 697 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
 698 void LLVMDeleteFunction(LLVMValueRef Fn);
 699 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
 700 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
 701 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
 702 const char *LLVMGetGC(LLVMValueRef Fn);
 703 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
 704 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
 705 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
 706 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
 707
 708 /* Operations on parameters */
 709 unsigned LLVMCountParams(LLVMValueRef Fn);
 710 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
 711 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
 712 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
 713 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
 714 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
 715 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
 716 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
 717 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
 718 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
 719 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
 720 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
 721
 722 /* Operations on basic blocks */
 723 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
 724 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
 725 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
 726 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
 727 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
 728 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
 729 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
 730 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
 731 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
 732 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
 733 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
 734
 735 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
 736                                                 LLVMValueRef Fn,
 737                                                 const char *Name);
 738 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
 739                                                 LLVMBasicBlockRef BB,
 740                                                 const char *Name);
 741
 742 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
 743 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
 744                                        const char *Name);
 745 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
 746
 747 /* Operations on instructions */
 748 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
 749 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
 750 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
 751 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
 752 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
 753
 754 /* Operations on call sites */
 755 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
 756 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
 757 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
 758 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
 759                               LLVMAttribute);
 760 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
 761                                 unsigned align);
 762
 763 /* Operations on call instructions (only) */
 764 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
 765 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
 766
 767 /* Operations on phi nodes */
 768 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
 769                      LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
 770 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
 771 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
 772 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
 773
 774 /*===-- Instruction builders ----------------------------------------------===*/
 775
 776 /* An instruction builder represents a point within a basic block, and is the
 777  * exclusive means of building instructions using the C interface.
 778  */
 779
 780 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
 781 LLVMBuilderRef LLVMCreateBuilder(void);
 782 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
 783                          LLVMValueRef Instr);
 784 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
 785 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
 786 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
 787 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
 788 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
 789 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
 790                                    const char *Name);
 791 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
 792
 793 /* Metadata */
 794 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
 795 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
 796 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
 797
 798 /* Terminators */
 799 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
 800 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
 801 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
 802                                    unsigned N);
 803 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
 804 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
 805                              LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
 806 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
 807                              LLVMBasicBlockRef Else, unsigned NumCases);
 808 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
 809                              LLVMValueRef *Args, unsigned NumArgs,
 810                              LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
 811                              const char *Name);
 812 LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
 813 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
 814
 815 /* Add a case to the switch instruction */
 816 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
 817                  LLVMBasicBlockRef Dest);
 818
 819 /* Arithmetic */
 820 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 821                           const char *Name);
 822 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 823                              const char *Name);
 824 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 825                              const char *Name);
 826 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 827                            const char *Name);
 828 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 829                           const char *Name);
 830 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 831                              const char *Name);
 832 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 833                              const char *Name);
 834 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 835                            const char *Name);
 836 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 837                           const char *Name);
 838 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 839                              const char *Name);
 840 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 841                              const char *Name);
 842 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 843                            const char *Name);
 844 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 845                            const char *Name);
 846 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 847                            const char *Name);
 848 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 849                                 const char *Name);
 850 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 851                            const char *Name);
 852 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 853                            const char *Name);
 854 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 855                            const char *Name);
 856 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 857                            const char *Name);
 858 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 859                            const char *Name);
 860 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 861                            const char *Name);
 862 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 863                            const char *Name);
 864 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 865                           const char *Name);
 866 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 867                           const char *Name);
 868 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 869                           const char *Name);
 870 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
 871                             LLVMValueRef LHS, LLVMValueRef RHS,
 872                             const char *Name);
 873 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
 874 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
 875                              const char *Name);
 876 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
 877                              const char *Name);
 878 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
 879 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
 880
 881 /* Memory */
 882 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
 883 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
 884                                   LLVMValueRef Val, const char *Name);
 885 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
 886 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
 887                                   LLVMValueRef Val, const char *Name);
 888 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
 889 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
 890                            const char *Name);
 891 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
 892 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
 893                           LLVMValueRef *Indices, unsigned NumIndices,
 894                           const char *Name);
 895 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
 896                                   LLVMValueRef *Indices, unsigned NumIndices,
 897                                   const char *Name);
 898 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
 899                                 unsigned Idx, const char *Name);
 900 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
 901                                    const char *Name);
 902 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
 903                                       const char *Name);
 904
 905 /* Casts */
 906 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
 907                             LLVMTypeRef DestTy, const char *Name);
 908 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
 909                            LLVMTypeRef DestTy, const char *Name);
 910 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
 911                            LLVMTypeRef DestTy, const char *Name);
 912 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
 913                              LLVMTypeRef DestTy, const char *Name);
 914 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
 915                              LLVMTypeRef DestTy, const char *Name);
 916 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
 917                              LLVMTypeRef DestTy, const char *Name);
 918 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
 919                              LLVMTypeRef DestTy, const char *Name);
 920 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
 921                               LLVMTypeRef DestTy, const char *Name);
 922 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
 923                             LLVMTypeRef DestTy, const char *Name);
 924 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
 925                                LLVMTypeRef DestTy, const char *Name);
 926 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
 927                                LLVMTypeRef DestTy, const char *Name);
 928 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
 929                               LLVMTypeRef DestTy, const char *Name);
 930 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
 931                                     LLVMTypeRef DestTy, const char *Name);
 932 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
 933                                     LLVMTypeRef DestTy, const char *Name);
 934 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
 935                                      LLVMTypeRef DestTy, const char *Name);
 936 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
 937                            LLVMTypeRef DestTy, const char *Name);
 938 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
 939                                   LLVMTypeRef DestTy, const char *Name);
 940 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
 941                               LLVMTypeRef DestTy, const char *Name);
 942 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
 943                              LLVMTypeRef DestTy, const char *Name);
 944
 945 /* Comparisons */
 946 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
 947                            LLVMValueRef LHS, LLVMValueRef RHS,
 948                            const char *Name);
 949 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
 950                            LLVMValueRef LHS, LLVMValueRef RHS,
 951                            const char *Name);
 952
 953 /* Miscellaneous instructions */
 954 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
 955 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
 956                            LLVMValueRef *Args, unsigned NumArgs,
 957                            const char *Name);
 958 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
 959                              LLVMValueRef Then, LLVMValueRef Else,
 960                              const char *Name);
 961 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
 962                             const char *Name);
 963 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
 964                                      LLVMValueRef Index, const char *Name);
 965 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
 966                                     LLVMValueRef EltVal, LLVMValueRef Index,
 967                                     const char *Name);
 968 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
 969                                     LLVMValueRef V2, LLVMValueRef Mask,
 970                                     const char *Name);
 971 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
 972                                    unsigned Index, const char *Name);
 973 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
 974                                   LLVMValueRef EltVal, unsigned Index,
 975                                   const char *Name);
 976
 977 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
 978                              const char *Name);
 979 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
 980                                 const char *Name);
 981 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
 982                               LLVMValueRef RHS, const char *Name);
 983
 984
 985 /*===-- Module providers --------------------------------------------------===*/
 986
 987 /* Changes the type of M so it can be passed to FunctionPassManagers and the
 988  * JIT.  They take ModuleProviders for historical reasons.
 989  */
 990 LLVMModuleProviderRef
 991 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
 992
 993 /* Destroys the module M.
 994  */
 995 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
 996
 997
 998 /*===-- Memory buffers ----------------------------------------------------===*/
 999
1000 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1001                                                   LLVMMemoryBufferRef *OutMemBuf,
1002                                                   char **OutMessage);
1003 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1004                                          char **OutMessage);
1005 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1006
1007
1008 /*===-- Pass Managers -----------------------------------------------------===*/
1009
1010 /** Constructs a new whole-module pass pipeline. This type of pipeline is
1011     suitable for link-time optimization and whole-module transformations.
1012     See llvm::PassManager::PassManager. */
1013 LLVMPassManagerRef LLVMCreatePassManager(void);
1014
1015 /** Constructs a new function-by-function pass pipeline over the module
1016     provider. It does not take ownership of the module provider. This type of
1017     pipeline is suitable for code generation and JIT compilation tasks.
1018     See llvm::FunctionPassManager::FunctionPassManager. */
1019 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1020
1021 /** Initializes, executes on the provided module, and finalizes all of the
1022     passes scheduled in the pass manager. Returns 1 if any of the passes
1023     modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
1024 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
1025
1026 /** Initializes all of the function passes scheduled in the function pass
1027     manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1028     See llvm::FunctionPassManager::doInitialization. */
1029 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
1030
1031 /** Executes all of the function passes scheduled in the function pass manager
1032     on the provided function. Returns 1 if any of the passes modified the
1033     function, false otherwise.
1034     See llvm::FunctionPassManager::run(Function&). */
1035 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
1036
1037 /** Finalizes all of the function passes scheduled in in the function pass
1038     manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1039     See llvm::FunctionPassManager::doFinalization. */
1040 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
1041
1042 /** Frees the memory of a pass pipeline. For function pipelines, does not free
1043     the module provider.
1044     See llvm::PassManagerBase::~PassManagerBase. */
1045 void LLVMDisposePassManager(LLVMPassManagerRef PM);
1046
1047
1048 #ifdef __cplusplus
1049 }
1050
1051 namespace llvm {
1052   class MemoryBuffer;
1053   class PassManagerBase;
1054
1055   #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)   \
1056     inline ty *unwrap(ref P) {                          \
1057       return reinterpret_cast<ty*>(P);                  \
1058     }                                                   \
1059                                                         \
1060     inline ref wrap(const ty *P) {                      \
1061       return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1062     }
1063
1064   #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref)  \
1065     DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)         \
1066                                                         \
1067     template<typename T>                                \
1068     inline T *unwrap(ref P) {                           \
1069       return cast<T>(unwrap(P));                        \
1070     }
1071
1072   #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref)   \
1073     DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)         \
1074                                                         \
1075     template<typename T>                                \
1076     inline T *unwrap(ref P) {                           \
1077       T *Q = (T*)unwrap(P);                             \
1078       assert(Q && "Invalid cast!");                     \
1079       return Q;                                         \
1080     }
1081
1082   DEFINE_ISA_CONVERSION_FUNCTIONS   (Type,               LLVMTypeRef          )
1083   DEFINE_ISA_CONVERSION_FUNCTIONS   (Value,              LLVMValueRef         )
1084   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module,             LLVMModuleRef        )
1085   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock,         LLVMBasicBlockRef    )
1086   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>,        LLVMBuilderRef       )
1087   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder,       LLVMTypeHandleRef    )
1088   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer,       LLVMMemoryBufferRef  )
1089   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext,        LLVMContextRef       )
1090   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use,                LLVMUseIteratorRef           )
1091   DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase,    LLVMPassManagerRef   )
1092   /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1093    * Module.
1094    */
1095   inline Module *unwrap(LLVMModuleProviderRef MP) {
1096     return reinterpret_cast<Module*>(MP);
1097   }
1098
1099   #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1100   #undef DEFINE_ISA_CONVERSION_FUNCTIONS
1101   #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
1102
1103   /* Specialized opaque context conversions.
1104    */
1105   inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1106     return reinterpret_cast<LLVMContext**>(Tys);
1107   }
1108
1109   inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1110     return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1111   }
1112
1113   /* Specialized opaque type conversions.
1114    */
1115   inline Type **unwrap(LLVMTypeRef* Tys) {
1116     return reinterpret_cast<Type**>(Tys);
1117   }
1118
1119   inline LLVMTypeRef *wrap(const Type **Tys) {
1120     return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1121   }
1122
1123   /* Specialized opaque value conversions.
1124    */
1125   inline Value **unwrap(LLVMValueRef *Vals) {
1126     return reinterpret_cast<Value**>(Vals);
1127   }
1128
1129   template<typename T>
1130   inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1131     #if DEBUG
1132     for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
1133       cast<T>(*I);
1134     #endif
1135     return reinterpret_cast<T**>(Vals);
1136   }
1137
1138   inline LLVMValueRef *wrap(const Value **Vals) {
1139     return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1140   }
1141 }
1142
1143 #endif /* !defined(__cplusplus) */
1144
1145 #endif /* !defined(LLVM_C_CORE_H) */