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 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
 659
 660 /* Operations on global variables, functions, and aliases (globals) */
 661 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
 662 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
 663 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
 664 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
 665 const char *LLVMGetSection(LLVMValueRef Global);
 666 void LLVMSetSection(LLVMValueRef Global, const char *Section);
 667 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
 668 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
 669 unsigned LLVMGetAlignment(LLVMValueRef Global);
 670 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
 671
 672 /* Operations on global variables */
 673 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
 674 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
 675                                          const char *Name,
 676                                          unsigned AddressSpace);
 677 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
 678 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
 679 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
 680 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
 681 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
 682 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
 683 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
 684 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
 685 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
 686 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
 687 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
 688 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
 689
 690 /* Operations on aliases */
 691 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
 692                           const char *Name);
 693
 694 /* Operations on functions */
 695 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
 696                              LLVMTypeRef FunctionTy);
 697 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
 698 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
 699 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
 700 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
 701 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
 702 void LLVMDeleteFunction(LLVMValueRef Fn);
 703 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
 704 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
 705 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
 706 const char *LLVMGetGC(LLVMValueRef Fn);
 707 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
 708 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
 709 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
 710 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
 711
 712 /* Operations on parameters */
 713 unsigned LLVMCountParams(LLVMValueRef Fn);
 714 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
 715 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
 716 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
 717 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
 718 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
 719 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
 720 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
 721 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
 722 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
 723 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
 724 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
 725
 726 /* Operations on basic blocks */
 727 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
 728 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
 729 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
 730 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
 731 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
 732 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
 733 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
 734 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
 735 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
 736 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
 737 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
 738
 739 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
 740                                                 LLVMValueRef Fn,
 741                                                 const char *Name);
 742 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
 743                                                 LLVMBasicBlockRef BB,
 744                                                 const char *Name);
 745
 746 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
 747 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
 748                                        const char *Name);
 749 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
 750
 751 /* Operations on instructions */
 752 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
 753 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
 754 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
 755 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
 756 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
 757
 758 /* Operations on call sites */
 759 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
 760 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
 761 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
 762 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
 763                               LLVMAttribute);
 764 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
 765                                 unsigned align);
 766
 767 /* Operations on call instructions (only) */
 768 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
 769 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
 770
 771 /* Operations on phi nodes */
 772 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
 773                      LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
 774 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
 775 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
 776 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
 777
 778 /*===-- Instruction builders ----------------------------------------------===*/
 779
 780 /* An instruction builder represents a point within a basic block, and is the
 781  * exclusive means of building instructions using the C interface.
 782  */
 783
 784 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
 785 LLVMBuilderRef LLVMCreateBuilder(void);
 786 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
 787                          LLVMValueRef Instr);
 788 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
 789 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
 790 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
 791 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
 792 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
 793 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
 794                                    const char *Name);
 795 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
 796
 797 /* Metadata */
 798 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
 799 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
 800 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
 801
 802 /* Terminators */
 803 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
 804 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
 805 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
 806                                    unsigned N);
 807 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
 808 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
 809                              LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
 810 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
 811                              LLVMBasicBlockRef Else, unsigned NumCases);
 812 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
 813                                  unsigned NumDests);
 814 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
 815                              LLVMValueRef *Args, unsigned NumArgs,
 816                              LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
 817                              const char *Name);
 818 LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
 819 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
 820
 821 /* Add a case to the switch instruction */
 822 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
 823                  LLVMBasicBlockRef Dest);
 824
 825 /* Add a destination to the indirectbr instruction */
 826 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
 827
 828 /* Arithmetic */
 829 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 830                           const char *Name);
 831 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 832                              const char *Name);
 833 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 834                              const char *Name);
 835 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 836                            const char *Name);
 837 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 838                           const char *Name);
 839 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 840                              const char *Name);
 841 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 842                              const char *Name);
 843 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 844                            const char *Name);
 845 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 846                           const char *Name);
 847 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 848                              const char *Name);
 849 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 850                              const char *Name);
 851 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 852                            const char *Name);
 853 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 854                            const char *Name);
 855 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 856                            const char *Name);
 857 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 858                                 const char *Name);
 859 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 860                            const char *Name);
 861 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 862                            const char *Name);
 863 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 864                            const char *Name);
 865 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 866                            const char *Name);
 867 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 868                            const char *Name);
 869 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 870                            const char *Name);
 871 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 872                            const char *Name);
 873 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 874                           const char *Name);
 875 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 876                           const char *Name);
 877 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
 878                           const char *Name);
 879 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
 880                             LLVMValueRef LHS, LLVMValueRef RHS,
 881                             const char *Name);
 882 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
 883 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
 884                              const char *Name);
 885 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
 886                              const char *Name);
 887 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
 888 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
 889
 890 /* Memory */
 891 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
 892 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
 893                                   LLVMValueRef Val, const char *Name);
 894 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
 895 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
 896                                   LLVMValueRef Val, const char *Name);
 897 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
 898 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
 899                            const char *Name);
 900 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
 901 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
 902                           LLVMValueRef *Indices, unsigned NumIndices,
 903                           const char *Name);
 904 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
 905                                   LLVMValueRef *Indices, unsigned NumIndices,
 906                                   const char *Name);
 907 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
 908                                 unsigned Idx, const char *Name);
 909 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
 910                                    const char *Name);
 911 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
 912                                       const char *Name);
 913
 914 /* Casts */
 915 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
 916                             LLVMTypeRef DestTy, const char *Name);
 917 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
 918                            LLVMTypeRef DestTy, const char *Name);
 919 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
 920                            LLVMTypeRef DestTy, const char *Name);
 921 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
 922                              LLVMTypeRef DestTy, const char *Name);
 923 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
 924                              LLVMTypeRef DestTy, const char *Name);
 925 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
 926                              LLVMTypeRef DestTy, const char *Name);
 927 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
 928                              LLVMTypeRef DestTy, const char *Name);
 929 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
 930                               LLVMTypeRef DestTy, const char *Name);
 931 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
 932                             LLVMTypeRef DestTy, const char *Name);
 933 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
 934                                LLVMTypeRef DestTy, const char *Name);
 935 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
 936                                LLVMTypeRef DestTy, const char *Name);
 937 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
 938                               LLVMTypeRef DestTy, const char *Name);
 939 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
 940                                     LLVMTypeRef DestTy, const char *Name);
 941 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
 942                                     LLVMTypeRef DestTy, const char *Name);
 943 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
 944                                      LLVMTypeRef DestTy, const char *Name);
 945 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
 946                            LLVMTypeRef DestTy, const char *Name);
 947 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
 948                                   LLVMTypeRef DestTy, const char *Name);
 949 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
 950                               LLVMTypeRef DestTy, const char *Name);
 951 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
 952                              LLVMTypeRef DestTy, const char *Name);
 953
 954 /* Comparisons */
 955 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
 956                            LLVMValueRef LHS, LLVMValueRef RHS,
 957                            const char *Name);
 958 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
 959                            LLVMValueRef LHS, LLVMValueRef RHS,
 960                            const char *Name);
 961
 962 /* Miscellaneous instructions */
 963 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
 964 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
 965                            LLVMValueRef *Args, unsigned NumArgs,
 966                            const char *Name);
 967 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
 968                              LLVMValueRef Then, LLVMValueRef Else,
 969                              const char *Name);
 970 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
 971                             const char *Name);
 972 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
 973                                      LLVMValueRef Index, const char *Name);
 974 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
 975                                     LLVMValueRef EltVal, LLVMValueRef Index,
 976                                     const char *Name);
 977 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
 978                                     LLVMValueRef V2, LLVMValueRef Mask,
 979                                     const char *Name);
 980 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
 981                                    unsigned Index, const char *Name);
 982 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
 983                                   LLVMValueRef EltVal, unsigned Index,
 984                                   const char *Name);
 985
 986 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
 987                              const char *Name);
 988 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
 989                                 const char *Name);
 990 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
 991                               LLVMValueRef RHS, const char *Name);
 992
 993
 994 /*===-- Module providers --------------------------------------------------===*/
 995
 996 /* Changes the type of M so it can be passed to FunctionPassManagers and the
 997  * JIT.  They take ModuleProviders for historical reasons.
 998  */
 999 LLVMModuleProviderRef
1000 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1001
1002 /* Destroys the module M.
1003  */
1004 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
1005
1006
1007 /*===-- Memory buffers ----------------------------------------------------===*/
1008
1009 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1010                                                   LLVMMemoryBufferRef *OutMemBuf,
1011                                                   char **OutMessage);
1012 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1013                                          char **OutMessage);
1014 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1015
1016
1017 /*===-- Pass Managers -----------------------------------------------------===*/
1018
1019 /** Constructs a new whole-module pass pipeline. This type of pipeline is
1020     suitable for link-time optimization and whole-module transformations.
1021     See llvm::PassManager::PassManager. */
1022 LLVMPassManagerRef LLVMCreatePassManager(void);
1023
1024 /** Constructs a new function-by-function pass pipeline over the module
1025     provider. It does not take ownership of the module provider. This type of
1026     pipeline is suitable for code generation and JIT compilation tasks.
1027     See llvm::FunctionPassManager::FunctionPassManager. */
1028 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1029
1030 /** Initializes, executes on the provided module, and finalizes all of the
1031     passes scheduled in the pass manager. Returns 1 if any of the passes
1032     modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
1033 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
1034
1035 /** Initializes all of the function passes scheduled in the function pass
1036     manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1037     See llvm::FunctionPassManager::doInitialization. */
1038 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
1039
1040 /** Executes all of the function passes scheduled in the function pass manager
1041     on the provided function. Returns 1 if any of the passes modified the
1042     function, false otherwise.
1043     See llvm::FunctionPassManager::run(Function&). */
1044 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
1045
1046 /** Finalizes all of the function passes scheduled in in the function pass
1047     manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1048     See llvm::FunctionPassManager::doFinalization. */
1049 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
1050
1051 /** Frees the memory of a pass pipeline. For function pipelines, does not free
1052     the module provider.
1053     See llvm::PassManagerBase::~PassManagerBase. */
1054 void LLVMDisposePassManager(LLVMPassManagerRef PM);
1055
1056
1057 #ifdef __cplusplus
1058 }
1059
1060 namespace llvm {
1061   class MemoryBuffer;
1062   class PassManagerBase;
1063
1064   #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)   \
1065     inline ty *unwrap(ref P) {                          \
1066       return reinterpret_cast<ty*>(P);                  \
1067     }                                                   \
1068                                                         \
1069     inline ref wrap(const ty *P) {                      \
1070       return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1071     }
1072
1073   #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref)  \
1074     DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)         \
1075                                                         \
1076     template<typename T>                                \
1077     inline T *unwrap(ref P) {                           \
1078       return cast<T>(unwrap(P));                        \
1079     }
1080
1081   #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref)   \
1082     DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)         \
1083                                                         \
1084     template<typename T>                                \
1085     inline T *unwrap(ref P) {                           \
1086       T *Q = (T*)unwrap(P);                             \
1087       assert(Q && "Invalid cast!");                     \
1088       return Q;                                         \
1089     }
1090
1091   DEFINE_ISA_CONVERSION_FUNCTIONS   (Type,               LLVMTypeRef          )
1092   DEFINE_ISA_CONVERSION_FUNCTIONS   (Value,              LLVMValueRef         )
1093   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module,             LLVMModuleRef        )
1094   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock,         LLVMBasicBlockRef    )
1095   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>,        LLVMBuilderRef       )
1096   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder,       LLVMTypeHandleRef    )
1097   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer,       LLVMMemoryBufferRef  )
1098   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext,        LLVMContextRef       )
1099   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use,                LLVMUseIteratorRef           )
1100   DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase,    LLVMPassManagerRef   )
1101   /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1102    * Module.
1103    */
1104   inline Module *unwrap(LLVMModuleProviderRef MP) {
1105     return reinterpret_cast<Module*>(MP);
1106   }
1107
1108   #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1109   #undef DEFINE_ISA_CONVERSION_FUNCTIONS
1110   #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
1111
1112   /* Specialized opaque context conversions.
1113    */
1114   inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1115     return reinterpret_cast<LLVMContext**>(Tys);
1116   }
1117
1118   inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1119     return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1120   }
1121
1122   /* Specialized opaque type conversions.
1123    */
1124   inline Type **unwrap(LLVMTypeRef* Tys) {
1125     return reinterpret_cast<Type**>(Tys);
1126   }
1127
1128   inline LLVMTypeRef *wrap(const Type **Tys) {
1129     return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1130   }
1131
1132   /* Specialized opaque value conversions.
1133    */
1134   inline Value **unwrap(LLVMValueRef *Vals) {
1135     return reinterpret_cast<Value**>(Vals);
1136   }
1137
1138   template<typename T>
1139   inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1140     #if DEBUG
1141     for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
1142       cast<T>(*I);
1143     #endif
1144     return reinterpret_cast<T**>(Vals);
1145   }
1146
1147   inline LLVMValueRef *wrap(const Value **Vals) {
1148     return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1149   }
1150 }
1151
1152 #endif /* !defined(__cplusplus) */
1153
1154 #endif /* !defined(LLVM_C_CORE_H) */