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