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