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