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