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