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