blob: 457436d121991b4cffc6be2675b5f56cb3328c1d [file] [log] [blame]
Gordon Henriksen8b94a142007-09-18 03:18:57 +00001/*===-- llvm-c/Core.h - Core Library C Interface ------------------*- C -*-===*\
2|* *|
3|* The LLVM Compiler Infrastructure *|
4|* *|
Chris Lattner7ed47a12007-12-29 19:59:42 +00005|* This file is distributed under the University of Illinois Open Source *|
6|* License. See LICENSE.TXT for details. *|
Gordon Henriksen8b94a142007-09-18 03:18:57 +00007|* *|
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|* *|
Gordon Henriksenacd96192007-10-05 23:59:36 +000026|* 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|* *|
Gordon Henriksen8b94a142007-09-18 03:18:57 +000031\*===----------------------------------------------------------------------===*/
32
33#ifndef LLVM_C_CORE_H
34#define LLVM_C_CORE_H
35
Chandler Carruth8b67f772009-10-26 01:35:46 +000036#include "llvm/System/DataTypes.h"
Erick Tryzelaare0a1bf62009-08-16 23:36:46 +000037
Gordon Henriksen8b94a142007-09-18 03:18:57 +000038#ifdef __cplusplus
Gordon Henriksenacd96192007-10-05 23:59:36 +000039
40/* Need these includes to support the LLVM 'cast' template for the C++ 'wrap'
41 and 'unwrap' conversion functions. */
42#include "llvm/Module.h"
Duncan Sands89f6d882008-04-13 06:22:09 +000043#include "llvm/Support/IRBuilder.h"
Gordon Henriksenacd96192007-10-05 23:59:36 +000044
Gordon Henriksen8b94a142007-09-18 03:18:57 +000045extern "C" {
46#endif
47
48
Chris Lattnerd686c8e2010-01-09 22:27:07 +000049typedef int LLVMBool;
50
Gordon Henriksen8b94a142007-09-18 03:18:57 +000051/* Opaque types. */
Gordon Henriksendc2c07a2007-12-30 17:46:33 +000052
53/**
Owen Anderson8b477ed2009-07-01 16:58:40 +000054 * The top-level container for all LLVM global data. See the LLVMContext class.
55 */
Erick Tryzelaar22c3f182009-08-14 00:01:31 +000056typedef struct LLVMOpaqueContext *LLVMContextRef;
Owen Anderson8b477ed2009-07-01 16:58:40 +000057
58/**
Gordon Henriksendc2c07a2007-12-30 17:46:33 +000059 * The top-level container for all other LLVM Intermediate Representation (IR)
60 * objects. See the llvm::Module class.
61 */
Gordon Henriksen8b94a142007-09-18 03:18:57 +000062typedef struct LLVMOpaqueModule *LLVMModuleRef;
Gordon Henriksendc2c07a2007-12-30 17:46:33 +000063
64/**
Gordon Henriksenbbf1c512008-03-07 19:13:06 +000065 * Each value in the LLVM IR has a type, an LLVMTypeRef. See the llvm::Type
66 * class.
Gordon Henriksendc2c07a2007-12-30 17:46:33 +000067 */
Gordon Henriksen8b94a142007-09-18 03:18:57 +000068typedef struct LLVMOpaqueType *LLVMTypeRef;
Gordon Henriksendc2c07a2007-12-30 17:46:33 +000069
70/**
Gordon Henriksenbbf1c512008-03-07 19:13:06 +000071 * When building recursive types using LLVMRefineType, LLVMTypeRef values may
72 * become invalid; use LLVMTypeHandleRef to resolve this problem. See the
73 * llvm::AbstractTypeHolder class.
Gordon Henriksendc2c07a2007-12-30 17:46:33 +000074 */
Gordon Henriksen1cf08fd2007-10-07 00:13:35 +000075typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef;
Gordon Henriksendc2c07a2007-12-30 17:46:33 +000076
Gordon Henriksen8b94a142007-09-18 03:18:57 +000077typedef struct LLVMOpaqueValue *LLVMValueRef;
Gordon Henriksen46abf912007-09-26 20:56:12 +000078typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
79typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
Gordon Henriksenda1435f2007-12-19 22:30:40 +000080
Jeffrey Yasskinf0356fe2010-01-27 20:34:15 +000081/* 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.
Gordon Henriksenda1435f2007-12-19 22:30:40 +000084 */
Gordon Henriksen1ae61352007-12-12 01:04:30 +000085typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
Gordon Henriksen8b94a142007-09-18 03:18:57 +000086
Gordon Henriksenda1435f2007-12-19 22:30:40 +000087/* Used to provide a module to JIT or interpreter.
88 * See the llvm::MemoryBuffer class.
89 */
90typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
91
Gordon Henriksend78c0f52008-03-16 04:20:44 +000092/** See the llvm::PassManagerBase class. */
93typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
94
Erick Tryzelaar24b37332010-03-02 20:32:28 +000095/** Used to get the users and usees of a Value. See the llvm::Use class. */
96typedef struct LLVMOpaqueUse *LLVMUseRef;
Chris Lattner885dffc2009-10-12 04:01:02 +000097
Gordon Henriksen8b94a142007-09-18 03:18:57 +000098typedef enum {
Devang Patel05988662008-09-25 21:00:45 +000099 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,
Anton Korobeynikovc5ec8a72009-07-17 18:07:26 +0000109 LLVMReadOnlyAttribute = 1<<10,
Anton Korobeynikov46a47f52009-07-17 18:57:16 +0000110 LLVMNoInlineAttribute = 1<<11,
111 LLVMAlwaysInlineAttribute = 1<<12,
112 LLVMOptimizeForSizeAttribute = 1<<13,
113 LLVMStackProtectAttribute = 1<<14,
114 LLVMStackProtectReqAttribute = 1<<15,
115 LLVMNoCaptureAttribute = 1<<21,
116 LLVMNoRedZoneAttribute = 1<<22,
117 LLVMNoImplicitFloatAttribute = 1<<23,
Jakob Stoklund Olesen570a4a52010-02-06 01:16:28 +0000118 LLVMNakedAttribute = 1<<24,
119 LLVMInlineHintAttribute = 1<<25
Devang Patel05988662008-09-25 21:00:45 +0000120} LLVMAttribute;
Gordon Henriksene2435da2008-04-28 17:37:06 +0000121
122typedef enum {
Bill Wendlingb218b272010-02-15 20:53:17 +0000123 /* Terminator Instructions */
Chris Lattner885dffc2009-10-12 04:01:02 +0000124 LLVMRet = 1,
125 LLVMBr = 2,
126 LLVMSwitch = 3,
Bill Wendlingcb0b7be2010-02-15 20:50:51 +0000127 LLVMIndirectBr = 4,
128 LLVMInvoke = 5,
129 LLVMUnwind = 6,
130 LLVMUnreachable = 7,
131
Bill Wendlingb218b272010-02-15 20:53:17 +0000132 /* Standard Binary Operators */
Bill Wendlingcb0b7be2010-02-15 20:50:51 +0000133 LLVMAdd = 8,
134 LLVMFAdd = 9,
135 LLVMSub = 10,
136 LLVMFSub = 11,
137 LLVMMul = 12,
138 LLVMFMul = 13,
139 LLVMUDiv = 14,
140 LLVMSDiv = 15,
141 LLVMFDiv = 16,
142 LLVMURem = 17,
143 LLVMSRem = 18,
144 LLVMFRem = 19,
145
Bill Wendlingb218b272010-02-15 20:53:17 +0000146 /* Logical Operators */
Bill Wendlingcb0b7be2010-02-15 20:50:51 +0000147 LLVMShl = 20,
148 LLVMLShr = 21,
149 LLVMAShr = 22,
150 LLVMAnd = 23,
151 LLVMOr = 24,
152 LLVMXor = 25,
153
Bill Wendlingb218b272010-02-15 20:53:17 +0000154 /* Memory Operators */
Bill Wendlingcb0b7be2010-02-15 20:50:51 +0000155 LLVMAlloca = 26,
156 LLVMLoad = 27,
157 LLVMStore = 28,
158 LLVMGetElementPtr = 29,
159
Bill Wendlingb218b272010-02-15 20:53:17 +0000160 /* Cast Operators */
Erick Tryzelaara1461d32010-02-16 03:45:23 +0000161 LLVMTrunc = 30,
Bill Wendlingcb0b7be2010-02-15 20:50:51 +0000162 LLVMZExt = 31,
163 LLVMSExt = 32,
164 LLVMFPToUI = 33,
165 LLVMFPToSI = 34,
166 LLVMUIToFP = 35,
167 LLVMSIToFP = 36,
168 LLVMFPTrunc = 37,
169 LLVMFPExt = 38,
170 LLVMPtrToInt = 39,
171 LLVMIntToPtr = 40,
172 LLVMBitCast = 41,
173
Bill Wendlingb218b272010-02-15 20:53:17 +0000174 /* Other Operators */
Bill Wendlingcb0b7be2010-02-15 20:50:51 +0000175 LLVMICmp = 42,
176 LLVMFCmp = 43,
177 LLVMPHI = 44,
178 LLVMCall = 45,
179 LLVMSelect = 46,
Bill Wendlingb218b272010-02-15 20:53:17 +0000180 /* UserOp1 */
181 /* UserOp2 */
Bill Wendlingcb0b7be2010-02-15 20:50:51 +0000182 LLVMVAArg = 49,
183 LLVMExtractElement = 50,
184 LLVMInsertElement = 51,
185 LLVMShuffleVector = 52,
186 LLVMExtractValue = 53,
187 LLVMInsertValue = 54
Chris Lattner885dffc2009-10-12 04:01:02 +0000188} LLVMOpcode;
189
190typedef enum {
Gordon Henriksendc2c07a2007-12-30 17:46:33 +0000191 LLVMVoidTypeKind, /**< type with no size */
192 LLVMFloatTypeKind, /**< 32 bit floating point type */
193 LLVMDoubleTypeKind, /**< 64 bit floating point type */
194 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
195 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
196 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
197 LLVMLabelTypeKind, /**< Labels */
198 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
199 LLVMFunctionTypeKind, /**< Functions */
200 LLVMStructTypeKind, /**< Structures */
201 LLVMArrayTypeKind, /**< Arrays */
202 LLVMPointerTypeKind, /**< Pointers */
203 LLVMOpaqueTypeKind, /**< Opaque: type with unknown structure */
Chris Lattner0df5c8e2009-07-15 22:00:31 +0000204 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
Chris Lattnerfdfeb692010-02-12 20:49:41 +0000205 LLVMMetadataTypeKind, /**< Metadata */
206 LLVMUnionTypeKind /**< Unions */
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000207} LLVMTypeKind;
208
209typedef enum {
Gordon Henriksendc2c07a2007-12-30 17:46:33 +0000210 LLVMExternalLinkage, /**< Externally visible function */
Chris Lattnerdb1afd42009-04-13 06:25:37 +0000211 LLVMAvailableExternallyLinkage,
Duncan Sands667d4b82009-03-07 15:45:40 +0000212 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
213 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
214 equivalent. */
215 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
216 LLVMWeakODRLinkage, /**< Same, but only replaced by something
217 equivalent. */
Gordon Henriksendc2c07a2007-12-30 17:46:33 +0000218 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
219 LLVMInternalLinkage, /**< Rename collisions when linking (static
220 functions) */
Duncan Sands667d4b82009-03-07 15:45:40 +0000221 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
Gordon Henriksendc2c07a2007-12-30 17:46:33 +0000222 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
223 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
Duncan Sands5f4ee1f2009-03-11 08:08:06 +0000224 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
Jeffrey Yasskinf0356fe2010-01-27 20:34:15 +0000225 LLVMGhostLinkage, /**< Obsolete */
Bill Wendling39a499b2009-07-20 18:22:52 +0000226 LLVMCommonLinkage, /**< Tentative definitions */
227 LLVMLinkerPrivateLinkage /**< Like Private, but linker removes. */
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000228} LLVMLinkage;
229
230typedef enum {
Gordon Henriksendc2c07a2007-12-30 17:46:33 +0000231 LLVMDefaultVisibility, /**< The GV is visible */
232 LLVMHiddenVisibility, /**< The GV is hidden */
233 LLVMProtectedVisibility /**< The GV is protected */
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000234} LLVMVisibility;
235
Gordon Henriksen46abf912007-09-26 20:56:12 +0000236typedef enum {
237 LLVMCCallConv = 0,
238 LLVMFastCallConv = 8,
239 LLVMColdCallConv = 9,
240 LLVMX86StdcallCallConv = 64,
241 LLVMX86FastcallCallConv = 65
242} LLVMCallConv;
243
244typedef enum {
Gordon Henriksendc2c07a2007-12-30 17:46:33 +0000245 LLVMIntEQ = 32, /**< equal */
246 LLVMIntNE, /**< not equal */
247 LLVMIntUGT, /**< unsigned greater than */
248 LLVMIntUGE, /**< unsigned greater or equal */
249 LLVMIntULT, /**< unsigned less than */
250 LLVMIntULE, /**< unsigned less or equal */
251 LLVMIntSGT, /**< signed greater than */
252 LLVMIntSGE, /**< signed greater or equal */
253 LLVMIntSLT, /**< signed less than */
254 LLVMIntSLE /**< signed less or equal */
Gordon Henriksen46abf912007-09-26 20:56:12 +0000255} LLVMIntPredicate;
256
257typedef enum {
Gordon Henriksendc2c07a2007-12-30 17:46:33 +0000258 LLVMRealPredicateFalse, /**< Always false (always folded) */
259 LLVMRealOEQ, /**< True if ordered and equal */
260 LLVMRealOGT, /**< True if ordered and greater than */
261 LLVMRealOGE, /**< True if ordered and greater than or equal */
262 LLVMRealOLT, /**< True if ordered and less than */
263 LLVMRealOLE, /**< True if ordered and less than or equal */
264 LLVMRealONE, /**< True if ordered and operands are unequal */
265 LLVMRealORD, /**< True if ordered (no nans) */
266 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
267 LLVMRealUEQ, /**< True if unordered or equal */
268 LLVMRealUGT, /**< True if unordered or greater than */
269 LLVMRealUGE, /**< True if unordered, greater than, or equal */
270 LLVMRealULT, /**< True if unordered or less than */
271 LLVMRealULE, /**< True if unordered, less than, or equal */
272 LLVMRealUNE, /**< True if unordered or not equal */
273 LLVMRealPredicateTrue /**< Always true (always folded) */
Gordon Henriksen46abf912007-09-26 20:56:12 +0000274} LLVMRealPredicate;
275
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000276
Gordon Henriksenda1435f2007-12-19 22:30:40 +0000277/*===-- Error handling ----------------------------------------------------===*/
278
279void LLVMDisposeMessage(char *Message);
280
281
Erick Tryzelaar46c80e02010-02-28 09:45:59 +0000282/*===-- Contexts ----------------------------------------------------------===*/
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000283
Owen Anderson8b477ed2009-07-01 16:58:40 +0000284/* Create and destroy contexts. */
Erick Tryzelaarbf4a68e2009-08-30 23:38:06 +0000285LLVMContextRef LLVMContextCreate(void);
286LLVMContextRef LLVMGetGlobalContext(void);
Owen Anderson8b477ed2009-07-01 16:58:40 +0000287void LLVMContextDispose(LLVMContextRef C);
288
Erick Tryzelaar46c80e02010-02-28 09:45:59 +0000289unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
290 unsigned SLen);
291unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
292
293/*===-- Modules -----------------------------------------------------------===*/
294
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000295/* Create and destroy modules. */
Gordon Henriksenbbf1c512008-03-07 19:13:06 +0000296/** See llvm::Module::Module. */
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000297LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Owen Andersonc8897d92009-07-02 07:17:57 +0000298LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
299 LLVMContextRef C);
Gordon Henriksenbbf1c512008-03-07 19:13:06 +0000300
301/** See llvm::Module::~Module. */
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000302void LLVMDisposeModule(LLVMModuleRef M);
303
Gordon Henriksenbbf1c512008-03-07 19:13:06 +0000304/** Data layout. See Module::getDataLayout. */
Gordon Henriksena353ffa2007-12-27 20:13:47 +0000305const char *LLVMGetDataLayout(LLVMModuleRef M);
306void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
307
Gordon Henriksenbbf1c512008-03-07 19:13:06 +0000308/** Target triple. See Module::getTargetTriple. */
Gordon Henriksena353ffa2007-12-27 20:13:47 +0000309const char *LLVMGetTarget(LLVMModuleRef M);
310void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
311
Gordon Henriksenbbf1c512008-03-07 19:13:06 +0000312/** See Module::addTypeName. */
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000313LLVMBool LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000314void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
Chris Lattnere4840bc2009-07-06 17:29:59 +0000315LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000316
Gordon Henriksenaf59b102008-03-14 23:58:56 +0000317/** See Module::dump. */
318void LLVMDumpModule(LLVMModuleRef M);
319
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000320
Gordon Henriksen46abf912007-09-26 20:56:12 +0000321/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000322
323/* LLVM types conform to the following hierarchy:
324 *
325 * types:
326 * integer type
327 * real type
328 * function type
329 * sequence types:
330 * array type
331 * pointer type
332 * vector type
333 * void type
334 * label type
335 * opaque type
336 */
337
Gordon Henriksenbbf1c512008-03-07 19:13:06 +0000338/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000339LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksenbbf1c512008-03-07 19:13:06 +0000340
Erick Tryzelaar22c3f182009-08-14 00:01:31 +0000341/** See llvm::LLVMType::getContext. */
342LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
343
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000344/* Operations on integer types */
Erick Tryzelaar22c3f182009-08-14 00:01:31 +0000345LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
346LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
347LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
348LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
349LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
350LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
351
Gordon Henriksen16c1f442008-05-04 12:55:34 +0000352LLVMTypeRef LLVMInt1Type(void);
353LLVMTypeRef LLVMInt8Type(void);
354LLVMTypeRef LLVMInt16Type(void);
355LLVMTypeRef LLVMInt32Type(void);
356LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksen81a78812007-10-06 16:05:20 +0000357LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000358unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000359
360/* Operations on real types */
Erick Tryzelaar22c3f182009-08-14 00:01:31 +0000361LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
362LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
363LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
364LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
365LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
366
Gordon Henriksen16c1f442008-05-04 12:55:34 +0000367LLVMTypeRef LLVMFloatType(void);
368LLVMTypeRef LLVMDoubleType(void);
369LLVMTypeRef LLVMX86FP80Type(void);
370LLVMTypeRef LLVMFP128Type(void);
371LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000372
373/* Operations on function types */
Gordon Henriksen81a78812007-10-06 16:05:20 +0000374LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
375 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000376 LLVMBool IsVarArg);
377LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000378LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
379unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
380void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000381
382/* Operations on struct types */
Erick Tryzelaar22c3f182009-08-14 00:01:31 +0000383LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000384 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksen81a78812007-10-06 16:05:20 +0000385LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000386 LLVMBool Packed);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000387unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000388void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000389LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000390
Chris Lattnerfdfeb692010-02-12 20:49:41 +0000391/* Operations on union types */
392LLVMTypeRef LLVMUnionTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
393 unsigned ElementCount);
394LLVMTypeRef LLVMUnionType(LLVMTypeRef *ElementTypes, unsigned ElementCount);
395unsigned LLVMCountUnionElementTypes(LLVMTypeRef UnionTy);
396void LLVMGetUnionElementTypes(LLVMTypeRef UnionTy, LLVMTypeRef *Dest);
397
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000398/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksen81a78812007-10-06 16:05:20 +0000399LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen57cebee2007-12-17 16:08:32 +0000400LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksen81a78812007-10-06 16:05:20 +0000401LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000402
403LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
404unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen57cebee2007-12-17 16:08:32 +0000405unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000406unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
407
408/* Operations on other types */
Erick Tryzelaar22c3f182009-08-14 00:01:31 +0000409LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
410LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
411LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
412
Gordon Henriksen16c1f442008-05-04 12:55:34 +0000413LLVMTypeRef LLVMVoidType(void);
414LLVMTypeRef LLVMLabelType(void);
415LLVMTypeRef LLVMOpaqueType(void);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000416
Gordon Henriksen1cf08fd2007-10-07 00:13:35 +0000417/* Operations on type handles */
418LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
419void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
420LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
421void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
422
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000423
424/*===-- Values ------------------------------------------------------------===*/
425
426/* The bulk of LLVM's object model consists of values, which comprise a very
427 * rich type hierarchy.
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000428 */
429
Gordon Henriksen2a9c6712008-12-19 18:39:45 +0000430#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
431 macro(Argument) \
432 macro(BasicBlock) \
433 macro(InlineAsm) \
434 macro(User) \
435 macro(Constant) \
436 macro(ConstantAggregateZero) \
437 macro(ConstantArray) \
438 macro(ConstantExpr) \
439 macro(ConstantFP) \
440 macro(ConstantInt) \
441 macro(ConstantPointerNull) \
442 macro(ConstantStruct) \
443 macro(ConstantVector) \
444 macro(GlobalValue) \
445 macro(Function) \
446 macro(GlobalAlias) \
447 macro(GlobalVariable) \
448 macro(UndefValue) \
449 macro(Instruction) \
450 macro(BinaryOperator) \
451 macro(CallInst) \
452 macro(IntrinsicInst) \
453 macro(DbgInfoIntrinsic) \
454 macro(DbgDeclareInst) \
Gordon Henriksen2a9c6712008-12-19 18:39:45 +0000455 macro(EHSelectorInst) \
456 macro(MemIntrinsic) \
457 macro(MemCpyInst) \
458 macro(MemMoveInst) \
459 macro(MemSetInst) \
460 macro(CmpInst) \
461 macro(FCmpInst) \
462 macro(ICmpInst) \
Gordon Henriksen2a9c6712008-12-19 18:39:45 +0000463 macro(ExtractElementInst) \
464 macro(GetElementPtrInst) \
465 macro(InsertElementInst) \
466 macro(InsertValueInst) \
467 macro(PHINode) \
468 macro(SelectInst) \
469 macro(ShuffleVectorInst) \
470 macro(StoreInst) \
471 macro(TerminatorInst) \
472 macro(BranchInst) \
473 macro(InvokeInst) \
474 macro(ReturnInst) \
475 macro(SwitchInst) \
476 macro(UnreachableInst) \
477 macro(UnwindInst) \
478 macro(UnaryInstruction) \
Victor Hernandez7b929da2009-10-23 21:09:37 +0000479 macro(AllocaInst) \
Gordon Henriksen2a9c6712008-12-19 18:39:45 +0000480 macro(CastInst) \
Gordon Henriksen95ca7312008-12-19 18:51:17 +0000481 macro(BitCastInst) \
482 macro(FPExtInst) \
483 macro(FPToSIInst) \
484 macro(FPToUIInst) \
485 macro(FPTruncInst) \
486 macro(IntToPtrInst) \
487 macro(PtrToIntInst) \
488 macro(SExtInst) \
489 macro(SIToFPInst) \
490 macro(TruncInst) \
491 macro(UIToFPInst) \
492 macro(ZExtInst) \
493 macro(ExtractValueInst) \
Gordon Henriksen95ca7312008-12-19 18:51:17 +0000494 macro(LoadInst) \
495 macro(VAArgInst)
Gordon Henriksen2a9c6712008-12-19 18:39:45 +0000496
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000497/* Operations on all values */
Gordon Henriksen46abf912007-09-26 20:56:12 +0000498LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000499const char *LLVMGetValueName(LLVMValueRef Val);
500void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen88cc6992007-10-06 00:08:49 +0000501void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner885dffc2009-10-12 04:01:02 +0000502void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaar46c80e02010-02-28 09:45:59 +0000503int LLVMHasMetadata(LLVMValueRef Val);
504LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
505void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000506
Gordon Henriksen2a9c6712008-12-19 18:39:45 +0000507/* Conversion functions. Return the input value if it is an instance of the
508 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
509#define LLVM_DECLARE_VALUE_CAST(name) \
510 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
511LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
512
Chris Lattner885dffc2009-10-12 04:01:02 +0000513/* Operations on Uses */
Erick Tryzelaar24b37332010-03-02 20:32:28 +0000514LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
515LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
516LLVMValueRef LLVMGetUser(LLVMUseRef U);
517LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner885dffc2009-10-12 04:01:02 +0000518
519/* Operations on Users */
520LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
521
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000522/* Operations on constants of any type */
Gordon Henriksene3b989d2007-10-06 15:11:06 +0000523LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
524LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000525LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000526LLVMBool LLVMIsConstant(LLVMValueRef Val);
527LLVMBool LLVMIsNull(LLVMValueRef Val);
528LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattnere4840bc2009-07-06 17:29:59 +0000529LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000530
Erick Tryzelaar46c80e02010-02-28 09:45:59 +0000531/* Operations on metadata */
532LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
533 unsigned SLen);
534LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
535LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
536 unsigned Count);
537LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
538
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000539/* Operations on scalar constants */
Gordon Henriksene3b989d2007-10-06 15:11:06 +0000540LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000541 LLVMBool SignExtend);
Erick Tryzelaare0a1bf62009-08-16 23:36:46 +0000542LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
543 uint8_t Radix);
544LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
545 unsigned SLen, uint8_t Radix);
Gordon Henriksene3b989d2007-10-06 15:11:06 +0000546LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksene62a8a32008-02-02 01:07:50 +0000547LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaare0a1bf62009-08-16 23:36:46 +0000548LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
549 unsigned SLen);
Chris Lattner885dffc2009-10-12 04:01:02 +0000550unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
551long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaare0a1bf62009-08-16 23:36:46 +0000552
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000553
554/* Operations on composite constants */
Erick Tryzelaar22c3f182009-08-14 00:01:31 +0000555LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000556 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar22c3f182009-08-14 00:01:31 +0000557LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
558 LLVMValueRef *ConstantVals,
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000559 unsigned Count, LLVMBool Packed);
Erick Tryzelaar22c3f182009-08-14 00:01:31 +0000560
Gordon Henriksene3b989d2007-10-06 15:11:06 +0000561LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000562 LLVMBool DontNullTerminate);
Gordon Henriksen877ee972008-04-25 03:21:19 +0000563LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksene3b989d2007-10-06 15:11:06 +0000564 LLVMValueRef *ConstantVals, unsigned Length);
565LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000566 LLVMBool Packed);
Gordon Henriksene3b989d2007-10-06 15:11:06 +0000567LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Erick Tryzelaar1940dd12010-02-28 05:51:33 +0000568LLVMValueRef LLVMConstUnion(LLVMTypeRef Ty, LLVMValueRef Val);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000569
Gordon Henriksen46475692007-10-06 14:29:36 +0000570/* Constant expressions */
Chris Lattner885dffc2009-10-12 04:01:02 +0000571LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaar44a708f2009-08-19 08:36:49 +0000572LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen46475692007-10-06 14:29:36 +0000573LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
574LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar19f047f2010-02-28 05:51:43 +0000575LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
576LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar56b22692009-08-16 02:20:12 +0000577LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen46475692007-10-06 14:29:36 +0000578LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
579LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohman6e7ad952009-09-03 23:34:49 +0000580LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar19f047f2010-02-28 05:51:43 +0000581LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar56b22692009-08-16 02:20:12 +0000582LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen46475692007-10-06 14:29:36 +0000583LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar19f047f2010-02-28 05:51:43 +0000584LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
585LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar56b22692009-08-16 02:20:12 +0000586LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen46475692007-10-06 14:29:36 +0000587LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar19f047f2010-02-28 05:51:43 +0000588LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
589LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar56b22692009-08-16 02:20:12 +0000590LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen46475692007-10-06 14:29:36 +0000591LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
592LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohman6e7ad952009-09-03 23:34:49 +0000593LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen46475692007-10-06 14:29:36 +0000594LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
595LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
596LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
597LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
598LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
599LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
600LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
601LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
602 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
604 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
605LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
606LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
607LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
609 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohman6e7ad952009-09-03 23:34:49 +0000610LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
611 LLVMValueRef *ConstantIndices,
612 unsigned NumIndices);
Gordon Henriksen46475692007-10-06 14:29:36 +0000613LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
614LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
615LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
616LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
617LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
618LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
619LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
620LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
621LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
622LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
623LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
624LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar56b22692009-08-16 02:20:12 +0000625LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
626 LLVMTypeRef ToType);
627LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
628 LLVMTypeRef ToType);
629LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
630 LLVMTypeRef ToType);
631LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
632 LLVMTypeRef ToType);
633LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000634 LLVMBool isSigned);
Erick Tryzelaar56b22692009-08-16 02:20:12 +0000635LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen46475692007-10-06 14:29:36 +0000636LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
637 LLVMValueRef ConstantIfTrue,
638 LLVMValueRef ConstantIfFalse);
639LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
640 LLVMValueRef IndexConstant);
641LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
642 LLVMValueRef ElementValueConstant,
643 LLVMValueRef IndexConstant);
644LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
645 LLVMValueRef VectorBConstant,
646 LLVMValueRef MaskConstant);
Dan Gohmanb5931172008-11-03 22:55:43 +0000647LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
648 unsigned NumIdx);
649LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
650 LLVMValueRef ElementValueConstant,
651 unsigned *IdxList, unsigned NumIdx);
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000652LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner851ba392008-12-17 21:39:50 +0000653 const char *AsmString, const char *Constraints,
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000654 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaarc59286b2010-02-28 09:46:06 +0000655LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen46475692007-10-06 14:29:36 +0000656
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000657/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksendc1ce7b2008-03-19 01:11:35 +0000658LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000659LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000660LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
661void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
662const char *LLVMGetSection(LLVMValueRef Global);
663void LLVMSetSection(LLVMValueRef Global, const char *Section);
664LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
665void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
666unsigned LLVMGetAlignment(LLVMValueRef Global);
667void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
668
669/* Operations on global variables */
670LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar8e130b12010-02-28 09:46:13 +0000671LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
672 const char *Name,
673 unsigned AddressSpace);
Gordon Henriksen6d6203d2007-10-08 03:45:09 +0000674LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen4733be32008-03-23 22:21:29 +0000675LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
676LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
677LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
678LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000679void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000680LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
681void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000682LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
683void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
684LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
685void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000686
Chris Lattner851ba392008-12-17 21:39:50 +0000687/* Operations on aliases */
688LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
689 const char *Name);
690
Gordon Henriksen46abf912007-09-26 20:56:12 +0000691/* Operations on functions */
692LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
693 LLVMTypeRef FunctionTy);
Gordon Henriksen6d6203d2007-10-08 03:45:09 +0000694LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen34000972008-03-19 03:47:18 +0000695LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
696LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
697LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
698LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000699void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000700unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
701unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
702void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksen5eca0752008-08-17 18:44:35 +0000703const char *LLVMGetGC(LLVMValueRef Fn);
704void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sandse149e992009-05-06 12:21:17 +0000705void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner885dffc2009-10-12 04:01:02 +0000706LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sandse149e992009-05-06 12:21:17 +0000707void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000708
Gordon Henriksendc1ce7b2008-03-19 01:11:35 +0000709/* Operations on parameters */
710unsigned LLVMCountParams(LLVMValueRef Fn);
711void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
712LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
713LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen4733be32008-03-23 22:21:29 +0000714LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
715LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
716LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
717LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel05988662008-09-25 21:00:45 +0000718void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
719void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner885dffc2009-10-12 04:01:02 +0000720LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksene2435da2008-04-28 17:37:06 +0000721void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksendc1ce7b2008-03-19 01:11:35 +0000722
Gordon Henriksen46abf912007-09-26 20:56:12 +0000723/* Operations on basic blocks */
Gordon Henriksen4733be32008-03-23 22:21:29 +0000724LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000725LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000726LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen4733be32008-03-23 22:21:29 +0000727LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000728unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
729void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen34000972008-03-19 03:47:18 +0000730LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
731LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
732LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
733LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000734LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar22c3f182009-08-14 00:01:31 +0000735
736LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
737 LLVMValueRef Fn,
738 const char *Name);
739LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
740 LLVMBasicBlockRef BB,
741 const char *Name);
742
Gordon Henriksen46abf912007-09-26 20:56:12 +0000743LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
744LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
745 const char *Name);
746void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
747
Gordon Henriksendc1ce7b2008-03-19 01:11:35 +0000748/* Operations on instructions */
749LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen34000972008-03-19 03:47:18 +0000750LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
751LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
752LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
753LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksendc1ce7b2008-03-19 01:11:35 +0000754
Gordon Henriksencc0928f2007-12-29 20:45:00 +0000755/* Operations on call sites */
756void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
757unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel05988662008-09-25 21:00:45 +0000758void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
759void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
760 LLVMAttribute);
Gordon Henriksene2435da2008-04-28 17:37:06 +0000761void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
762 unsigned align);
Gordon Henriksencc0928f2007-12-29 20:45:00 +0000763
Gordon Henriksen07cabf62008-08-30 16:34:54 +0000764/* Operations on call instructions (only) */
Chris Lattnerd686c8e2010-01-09 22:27:07 +0000765LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
766void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henriksen07cabf62008-08-30 16:34:54 +0000767
Gordon Henriksen2618a6c2007-10-08 18:14:39 +0000768/* Operations on phi nodes */
769void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
770 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
771unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
772LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
773LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000774
775/*===-- Instruction builders ----------------------------------------------===*/
776
777/* An instruction builder represents a point within a basic block, and is the
778 * exclusive means of building instructions using the C interface.
779 */
780
Erick Tryzelaar22c3f182009-08-14 00:01:31 +0000781LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksen16c1f442008-05-04 12:55:34 +0000782LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen34000972008-03-19 03:47:18 +0000783void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
784 LLVMValueRef Instr);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000785void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
786void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksendc1ce7b2008-03-19 01:11:35 +0000787LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner851ba392008-12-17 21:39:50 +0000788void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
789void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar5c1c2082009-08-16 02:20:57 +0000790void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
791 const char *Name);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000792void LLVMDisposeBuilder(LLVMBuilderRef Builder);
793
Erick Tryzelaar46c80e02010-02-28 09:45:59 +0000794/* Metadata */
795void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
796LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
797void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
798
Gordon Henriksen46abf912007-09-26 20:56:12 +0000799/* Terminators */
800LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
801LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaar44a708f2009-08-19 08:36:49 +0000802LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaarf72596c2009-08-16 02:19:59 +0000803 unsigned N);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000804LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
805LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
806 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
807LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
808 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaarc59286b2010-02-28 09:46:06 +0000809LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
810 unsigned NumDests);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000811LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
812 LLVMValueRef *Args, unsigned NumArgs,
813 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
814 const char *Name);
815LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
816LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
817
Gordon Henriksenab477cc2008-01-01 05:50:53 +0000818/* Add a case to the switch instruction */
819void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
820 LLVMBasicBlockRef Dest);
821
Erick Tryzelaarc59286b2010-02-28 09:46:06 +0000822/* Add a destination to the indirectbr instruction */
823void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
824
Gordon Henriksen46abf912007-09-26 20:56:12 +0000825/* Arithmetic */
826LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
827 const char *Name);
Erick Tryzelaarf72596c2009-08-16 02:19:59 +0000828LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
829 const char *Name);
Erick Tryzelaar19f047f2010-02-28 05:51:43 +0000830LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
831 const char *Name);
Erick Tryzelaarf72596c2009-08-16 02:19:59 +0000832LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
833 const char *Name);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000834LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
835 const char *Name);
Erick Tryzelaar19f047f2010-02-28 05:51:43 +0000836LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
837 const char *Name);
838LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
839 const char *Name);
Erick Tryzelaarf72596c2009-08-16 02:19:59 +0000840LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
841 const char *Name);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000842LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
843 const char *Name);
Erick Tryzelaar19f047f2010-02-28 05:51:43 +0000844LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
845 const char *Name);
846LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
847 const char *Name);
Erick Tryzelaarf72596c2009-08-16 02:19:59 +0000848LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
849 const char *Name);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000850LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
851 const char *Name);
852LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
853 const char *Name);
Erick Tryzelaarf72596c2009-08-16 02:19:59 +0000854LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
855 const char *Name);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000856LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
857 const char *Name);
858LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
859 const char *Name);
860LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
861 const char *Name);
862LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
863 const char *Name);
864LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
865 const char *Name);
866LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
867 const char *Name);
868LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
869 const char *Name);
870LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
871 const char *Name);
872LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
873 const char *Name);
874LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
875 const char *Name);
Erick Tryzelaarabbcc5e2010-02-28 05:51:27 +0000876LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
877 LLVMValueRef LHS, LLVMValueRef RHS,
878 const char *Name);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000879LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar19f047f2010-02-28 05:51:43 +0000880LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
881 const char *Name);
882LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
883 const char *Name);
Dan Gohmand0c5a292009-09-28 21:51:41 +0000884LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000885LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
886
887/* Memory */
888LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
889LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
890 LLVMValueRef Val, const char *Name);
891LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
892LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
893 LLVMValueRef Val, const char *Name);
894LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
895LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
896 const char *Name);
897LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
898LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
899 LLVMValueRef *Indices, unsigned NumIndices,
900 const char *Name);
Erick Tryzelaarf72596c2009-08-16 02:19:59 +0000901LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
902 LLVMValueRef *Indices, unsigned NumIndices,
903 const char *Name);
904LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
905 unsigned Idx, const char *Name);
906LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
907 const char *Name);
908LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
909 const char *Name);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000910
911/* Casts */
912LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
913 LLVMTypeRef DestTy, const char *Name);
914LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
915 LLVMTypeRef DestTy, const char *Name);
916LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
917 LLVMTypeRef DestTy, const char *Name);
918LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
919 LLVMTypeRef DestTy, const char *Name);
920LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
921 LLVMTypeRef DestTy, const char *Name);
922LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
923 LLVMTypeRef DestTy, const char *Name);
924LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
925 LLVMTypeRef DestTy, const char *Name);
926LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
927 LLVMTypeRef DestTy, const char *Name);
928LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
929 LLVMTypeRef DestTy, const char *Name);
930LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
931 LLVMTypeRef DestTy, const char *Name);
932LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
933 LLVMTypeRef DestTy, const char *Name);
934LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
935 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaarf72596c2009-08-16 02:19:59 +0000936LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
937 LLVMTypeRef DestTy, const char *Name);
938LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
939 LLVMTypeRef DestTy, const char *Name);
940LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
941 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaarabbcc5e2010-02-28 05:51:27 +0000942LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
943 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaarf72596c2009-08-16 02:19:59 +0000944LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
945 LLVMTypeRef DestTy, const char *Name);
Duncan Sandse8e01b62009-11-23 10:49:03 +0000946LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaarf72596c2009-08-16 02:19:59 +0000947 LLVMTypeRef DestTy, const char *Name);
948LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
949 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksen46abf912007-09-26 20:56:12 +0000950
951/* Comparisons */
952LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
953 LLVMValueRef LHS, LLVMValueRef RHS,
954 const char *Name);
955LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
956 LLVMValueRef LHS, LLVMValueRef RHS,
957 const char *Name);
958
959/* Miscellaneous instructions */
960LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
961LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
962 LLVMValueRef *Args, unsigned NumArgs,
963 const char *Name);
964LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
965 LLVMValueRef Then, LLVMValueRef Else,
966 const char *Name);
967LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
968 const char *Name);
969LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
970 LLVMValueRef Index, const char *Name);
971LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
972 LLVMValueRef EltVal, LLVMValueRef Index,
973 const char *Name);
974LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
975 LLVMValueRef V2, LLVMValueRef Mask,
976 const char *Name);
Dan Gohmanb5931172008-11-03 22:55:43 +0000977LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
978 unsigned Index, const char *Name);
979LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
980 LLVMValueRef EltVal, unsigned Index,
981 const char *Name);
Gordon Henriksen8b94a142007-09-18 03:18:57 +0000982
Erick Tryzelaarf72596c2009-08-16 02:19:59 +0000983LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
984 const char *Name);
985LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
986 const char *Name);
987LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
988 LLVMValueRef RHS, const char *Name);
989
Gordon Henriksenda1435f2007-12-19 22:30:40 +0000990
Gordon Henriksen1ae61352007-12-12 01:04:30 +0000991/*===-- Module providers --------------------------------------------------===*/
992
Jeffrey Yasskinf0356fe2010-01-27 20:34:15 +0000993/* Changes the type of M so it can be passed to FunctionPassManagers and the
994 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen1ae61352007-12-12 01:04:30 +0000995 */
996LLVMModuleProviderRef
997LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
998
Jeffrey Yasskinf0356fe2010-01-27 20:34:15 +0000999/* Destroys the module M.
Gordon Henriksen1ae61352007-12-12 01:04:30 +00001000 */
Jeffrey Yasskinf0356fe2010-01-27 20:34:15 +00001001void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen1ae61352007-12-12 01:04:30 +00001002
Gordon Henriksenda1435f2007-12-19 22:30:40 +00001003
1004/*===-- Memory buffers ----------------------------------------------------===*/
1005
Chris Lattnerd686c8e2010-01-09 22:27:07 +00001006LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1007 LLVMMemoryBufferRef *OutMemBuf,
1008 char **OutMessage);
1009LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1010 char **OutMessage);
Gordon Henriksenda1435f2007-12-19 22:30:40 +00001011void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1012
Gordon Henriksend78c0f52008-03-16 04:20:44 +00001013
1014/*===-- Pass Managers -----------------------------------------------------===*/
1015
1016/** Constructs a new whole-module pass pipeline. This type of pipeline is
1017 suitable for link-time optimization and whole-module transformations.
1018 See llvm::PassManager::PassManager. */
Gordon Henriksen16c1f442008-05-04 12:55:34 +00001019LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksend78c0f52008-03-16 04:20:44 +00001020
1021/** Constructs a new function-by-function pass pipeline over the module
1022 provider. It does not take ownership of the module provider. This type of
1023 pipeline is suitable for code generation and JIT compilation tasks.
1024 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaardf7df072010-03-02 23:58:54 +00001025LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1026
1027/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksend78c0f52008-03-16 04:20:44 +00001028LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1029
1030/** Initializes, executes on the provided module, and finalizes all of the
1031 passes scheduled in the pass manager. Returns 1 if any of the passes
1032 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattnerd686c8e2010-01-09 22:27:07 +00001033LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksend78c0f52008-03-16 04:20:44 +00001034
1035/** Initializes all of the function passes scheduled in the function pass
1036 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1037 See llvm::FunctionPassManager::doInitialization. */
Chris Lattnerd686c8e2010-01-09 22:27:07 +00001038LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksend78c0f52008-03-16 04:20:44 +00001039
1040/** Executes all of the function passes scheduled in the function pass manager
1041 on the provided function. Returns 1 if any of the passes modified the
1042 function, false otherwise.
1043 See llvm::FunctionPassManager::run(Function&). */
Chris Lattnerd686c8e2010-01-09 22:27:07 +00001044LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksend78c0f52008-03-16 04:20:44 +00001045
1046/** Finalizes all of the function passes scheduled in in the function pass
1047 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1048 See llvm::FunctionPassManager::doFinalization. */
Chris Lattnerd686c8e2010-01-09 22:27:07 +00001049LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksend78c0f52008-03-16 04:20:44 +00001050
1051/** Frees the memory of a pass pipeline. For function pipelines, does not free
1052 the module provider.
1053 See llvm::PassManagerBase::~PassManagerBase. */
1054void LLVMDisposePassManager(LLVMPassManagerRef PM);
1055
1056
Gordon Henriksen8b94a142007-09-18 03:18:57 +00001057#ifdef __cplusplus
1058}
Gordon Henriksen8b94a142007-09-18 03:18:57 +00001059
Gordon Henriksenacd96192007-10-05 23:59:36 +00001060namespace llvm {
Gordon Henriksenda1435f2007-12-19 22:30:40 +00001061 class MemoryBuffer;
Gordon Henriksen395b4142008-03-16 15:55:43 +00001062 class PassManagerBase;
Gordon Henriksen1ae61352007-12-12 01:04:30 +00001063
Gordon Henriksenda1435f2007-12-19 22:30:40 +00001064 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1065 inline ty *unwrap(ref P) { \
1066 return reinterpret_cast<ty*>(P); \
1067 } \
1068 \
1069 inline ref wrap(const ty *P) { \
1070 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1071 }
Gordon Henriksenacd96192007-10-05 23:59:36 +00001072
Gordon Henriksend78c0f52008-03-16 04:20:44 +00001073 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1074 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1075 \
1076 template<typename T> \
1077 inline T *unwrap(ref P) { \
1078 return cast<T>(unwrap(P)); \
1079 }
1080
1081 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1082 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1083 \
1084 template<typename T> \
1085 inline T *unwrap(ref P) { \
Chris Lattnere73a31f2010-01-22 06:49:46 +00001086 T *Q = (T*)unwrap(P); \
Gordon Henriksend78c0f52008-03-16 04:20:44 +00001087 assert(Q && "Invalid cast!"); \
1088 return Q; \
1089 }
1090
1091 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1092 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen1d2e49c2007-12-27 18:25:59 +00001093 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1094 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher7a61d702008-08-08 19:39:37 +00001095 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen1d2e49c2007-12-27 18:25:59 +00001096 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
Gordon Henriksen1d2e49c2007-12-27 18:25:59 +00001097 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson8b477ed2009-07-01 16:58:40 +00001098 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar24b37332010-03-02 20:32:28 +00001099 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksend78c0f52008-03-16 04:20:44 +00001100 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Jeffrey Yasskinf0356fe2010-01-27 20:34:15 +00001101 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1102 * Module.
1103 */
1104 inline Module *unwrap(LLVMModuleProviderRef MP) {
1105 return reinterpret_cast<Module*>(MP);
1106 }
Gordon Henriksenacd96192007-10-05 23:59:36 +00001107
Gordon Henriksend78c0f52008-03-16 04:20:44 +00001108 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1109 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksenda1435f2007-12-19 22:30:40 +00001110 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar22c3f182009-08-14 00:01:31 +00001111
1112 /* Specialized opaque context conversions.
1113 */
1114 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1115 return reinterpret_cast<LLVMContext**>(Tys);
1116 }
1117
1118 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1119 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1120 }
Gordon Henriksenacd96192007-10-05 23:59:36 +00001121
Gordon Henriksenda1435f2007-12-19 22:30:40 +00001122 /* Specialized opaque type conversions.
1123 */
Gordon Henriksenacd96192007-10-05 23:59:36 +00001124 inline Type **unwrap(LLVMTypeRef* Tys) {
1125 return reinterpret_cast<Type**>(Tys);
1126 }
1127
Gordon Henriksenacd96192007-10-05 23:59:36 +00001128 inline LLVMTypeRef *wrap(const Type **Tys) {
1129 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1130 }
1131
Gordon Henriksenda1435f2007-12-19 22:30:40 +00001132 /* Specialized opaque value conversions.
Gordon Henriksenacd96192007-10-05 23:59:36 +00001133 */
Gordon Henriksenacd96192007-10-05 23:59:36 +00001134 inline Value **unwrap(LLVMValueRef *Vals) {
1135 return reinterpret_cast<Value**>(Vals);
1136 }
1137
1138 template<typename T>
1139 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1140 #if DEBUG
Chris Lattner8b16f702009-07-10 18:28:19 +00001141 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksenacd96192007-10-05 23:59:36 +00001142 cast<T>(*I);
1143 #endif
1144 return reinterpret_cast<T**>(Vals);
1145 }
1146
Gordon Henriksenacd96192007-10-05 23:59:36 +00001147 inline LLVMValueRef *wrap(const Value **Vals) {
1148 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1149 }
Gordon Henriksenacd96192007-10-05 23:59:36 +00001150}
1151
1152#endif /* !defined(__cplusplus) */
1153
1154#endif /* !defined(LLVM_C_CORE_H) */