blob: d0fe536d5cf088a71f5940c889916f4ea4d4f72f [file] [log] [blame]
Gordon Henriksen76a03742007-09-18 03:18:57 +00001/*===-- llvm-c/Core.h - Core Library C Interface ------------------*- C -*-===*\
2|* *|
3|* The LLVM Compiler Infrastructure *|
4|* *|
Chris Lattnere9cc7422007-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 Henriksen76a03742007-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 Henriksen7330acd2007-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 Henriksen76a03742007-09-18 03:18:57 +000031\*===----------------------------------------------------------------------===*/
32
33#ifndef LLVM_C_CORE_H
34#define LLVM_C_CORE_H
35
Chandler Carruth56869f22009-10-26 01:35:46 +000036#include "llvm/System/DataTypes.h"
Erick Tryzelaardd991352009-08-16 23:36:46 +000037
Gordon Henriksen76a03742007-09-18 03:18:57 +000038#ifdef __cplusplus
Gordon Henriksen7330acd2007-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"
Owen Anderson4698c5d2010-10-07 17:55:47 +000043#include "llvm/PassRegistry.h"
Duncan Sandsa07136e2008-04-13 06:22:09 +000044#include "llvm/Support/IRBuilder.h"
Gordon Henriksen7330acd2007-10-05 23:59:36 +000045
Gordon Henriksen76a03742007-09-18 03:18:57 +000046extern "C" {
47#endif
48
49
Chris Lattner25963c62010-01-09 22:27:07 +000050typedef int LLVMBool;
51
Gordon Henriksen76a03742007-09-18 03:18:57 +000052/* Opaque types. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000053
54/**
Owen Anderson6773d382009-07-01 16:58:40 +000055 * The top-level container for all LLVM global data. See the LLVMContext class.
56 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +000057typedef struct LLVMOpaqueContext *LLVMContextRef;
Owen Anderson6773d382009-07-01 16:58:40 +000058
59/**
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000060 * The top-level container for all other LLVM Intermediate Representation (IR)
61 * objects. See the llvm::Module class.
62 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000063typedef struct LLVMOpaqueModule *LLVMModuleRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000064
65/**
Gordon Henriksena49d4352008-03-07 19:13:06 +000066 * Each value in the LLVM IR has a type, an LLVMTypeRef. See the llvm::Type
67 * class.
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000068 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000069typedef struct LLVMOpaqueType *LLVMTypeRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000070
71/**
Gordon Henriksena49d4352008-03-07 19:13:06 +000072 * When building recursive types using LLVMRefineType, LLVMTypeRef values may
73 * become invalid; use LLVMTypeHandleRef to resolve this problem. See the
74 * llvm::AbstractTypeHolder class.
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000075 */
Gordon Henriksenffb48762007-10-07 00:13:35 +000076typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000077
Gordon Henriksen76a03742007-09-18 03:18:57 +000078typedef struct LLVMOpaqueValue *LLVMValueRef;
Gordon Henriksenc23b66c2007-09-26 20:56:12 +000079typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
80typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000081
Jeffrey Yasskin091217b2010-01-27 20:34:15 +000082/* Interface used to provide a module to JIT or interpreter. This is now just a
83 * synonym for llvm::Module, but we have to keep using the different type to
84 * keep binary compatibility.
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000085 */
Gordon Henriksen0a68fe22007-12-12 01:04:30 +000086typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
Gordon Henriksen76a03742007-09-18 03:18:57 +000087
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000088/* Used to provide a module to JIT or interpreter.
89 * See the llvm::MemoryBuffer class.
90 */
91typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
92
Gordon Henriksen878114b2008-03-16 04:20:44 +000093/** See the llvm::PassManagerBase class. */
94typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
95
Owen Anderson4698c5d2010-10-07 17:55:47 +000096/** See the llvm::PassRegistry class. */
97typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef;
98
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +000099/** Used to get the users and usees of a Value. See the llvm::Use class. */
100typedef struct LLVMOpaqueUse *LLVMUseRef;
Chris Lattner40cf28d2009-10-12 04:01:02 +0000101
Gordon Henriksen76a03742007-09-18 03:18:57 +0000102typedef enum {
Devang Patel4c758ea2008-09-25 21:00:45 +0000103 LLVMZExtAttribute = 1<<0,
104 LLVMSExtAttribute = 1<<1,
105 LLVMNoReturnAttribute = 1<<2,
106 LLVMInRegAttribute = 1<<3,
107 LLVMStructRetAttribute = 1<<4,
108 LLVMNoUnwindAttribute = 1<<5,
109 LLVMNoAliasAttribute = 1<<6,
110 LLVMByValAttribute = 1<<7,
111 LLVMNestAttribute = 1<<8,
112 LLVMReadNoneAttribute = 1<<9,
Anton Korobeynikovc8ce7b082009-07-17 18:07:26 +0000113 LLVMReadOnlyAttribute = 1<<10,
Anton Korobeynikov9750be92009-07-17 18:57:16 +0000114 LLVMNoInlineAttribute = 1<<11,
115 LLVMAlwaysInlineAttribute = 1<<12,
116 LLVMOptimizeForSizeAttribute = 1<<13,
117 LLVMStackProtectAttribute = 1<<14,
118 LLVMStackProtectReqAttribute = 1<<15,
Erick Tryzelaar8f69fea2010-03-03 23:51:25 +0000119 LLVMAlignment = 31<<16,
Anton Korobeynikov9750be92009-07-17 18:57:16 +0000120 LLVMNoCaptureAttribute = 1<<21,
121 LLVMNoRedZoneAttribute = 1<<22,
122 LLVMNoImplicitFloatAttribute = 1<<23,
Jakob Stoklund Olesen74bb06c2010-02-06 01:16:28 +0000123 LLVMNakedAttribute = 1<<24,
Erick Tryzelaar8f69fea2010-03-03 23:51:25 +0000124 LLVMInlineHintAttribute = 1<<25,
125 LLVMStackAlignment = 7<<26
Devang Patel4c758ea2008-09-25 21:00:45 +0000126} LLVMAttribute;
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000127
128typedef enum {
Bill Wendlingda52cec2010-02-15 20:53:17 +0000129 /* Terminator Instructions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000130 LLVMRet = 1,
131 LLVMBr = 2,
132 LLVMSwitch = 3,
Bill Wendling07d6d762010-02-15 20:50:51 +0000133 LLVMIndirectBr = 4,
134 LLVMInvoke = 5,
135 LLVMUnwind = 6,
136 LLVMUnreachable = 7,
137
Bill Wendlingda52cec2010-02-15 20:53:17 +0000138 /* Standard Binary Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000139 LLVMAdd = 8,
140 LLVMFAdd = 9,
141 LLVMSub = 10,
142 LLVMFSub = 11,
143 LLVMMul = 12,
144 LLVMFMul = 13,
145 LLVMUDiv = 14,
146 LLVMSDiv = 15,
147 LLVMFDiv = 16,
148 LLVMURem = 17,
149 LLVMSRem = 18,
150 LLVMFRem = 19,
151
Bill Wendlingda52cec2010-02-15 20:53:17 +0000152 /* Logical Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000153 LLVMShl = 20,
154 LLVMLShr = 21,
155 LLVMAShr = 22,
156 LLVMAnd = 23,
157 LLVMOr = 24,
158 LLVMXor = 25,
159
Bill Wendlingda52cec2010-02-15 20:53:17 +0000160 /* Memory Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000161 LLVMAlloca = 26,
162 LLVMLoad = 27,
163 LLVMStore = 28,
164 LLVMGetElementPtr = 29,
165
Bill Wendlingda52cec2010-02-15 20:53:17 +0000166 /* Cast Operators */
Erick Tryzelaar5bf1a322010-02-16 03:45:23 +0000167 LLVMTrunc = 30,
Bill Wendling07d6d762010-02-15 20:50:51 +0000168 LLVMZExt = 31,
169 LLVMSExt = 32,
170 LLVMFPToUI = 33,
171 LLVMFPToSI = 34,
172 LLVMUIToFP = 35,
173 LLVMSIToFP = 36,
174 LLVMFPTrunc = 37,
175 LLVMFPExt = 38,
176 LLVMPtrToInt = 39,
177 LLVMIntToPtr = 40,
178 LLVMBitCast = 41,
179
Bill Wendlingda52cec2010-02-15 20:53:17 +0000180 /* Other Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000181 LLVMICmp = 42,
182 LLVMFCmp = 43,
183 LLVMPHI = 44,
184 LLVMCall = 45,
185 LLVMSelect = 46,
Bill Wendlingda52cec2010-02-15 20:53:17 +0000186 /* UserOp1 */
187 /* UserOp2 */
Bill Wendling07d6d762010-02-15 20:50:51 +0000188 LLVMVAArg = 49,
189 LLVMExtractElement = 50,
190 LLVMInsertElement = 51,
191 LLVMShuffleVector = 52,
192 LLVMExtractValue = 53,
193 LLVMInsertValue = 54
Chris Lattner40cf28d2009-10-12 04:01:02 +0000194} LLVMOpcode;
195
196typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000197 LLVMVoidTypeKind, /**< type with no size */
198 LLVMFloatTypeKind, /**< 32 bit floating point type */
199 LLVMDoubleTypeKind, /**< 64 bit floating point type */
200 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
201 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
202 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
203 LLVMLabelTypeKind, /**< Labels */
204 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
205 LLVMFunctionTypeKind, /**< Functions */
206 LLVMStructTypeKind, /**< Structures */
207 LLVMArrayTypeKind, /**< Arrays */
208 LLVMPointerTypeKind, /**< Pointers */
209 LLVMOpaqueTypeKind, /**< Opaque: type with unknown structure */
Chris Lattnerdac44ec2009-07-15 22:00:31 +0000210 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
Dale Johannesenbaa5d042010-09-10 20:55:01 +0000211 LLVMMetadataTypeKind, /**< Metadata */
212 LLVMX86_MMXTypeKind /**< X86 MMX */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000213} LLVMTypeKind;
214
215typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000216 LLVMExternalLinkage, /**< Externally visible function */
Chris Lattner2dba0f02009-04-13 06:25:37 +0000217 LLVMAvailableExternallyLinkage,
Duncan Sands12da8ce2009-03-07 15:45:40 +0000218 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
219 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
220 equivalent. */
221 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
222 LLVMWeakODRLinkage, /**< Same, but only replaced by something
223 equivalent. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000224 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
225 LLVMInternalLinkage, /**< Rename collisions when linking (static
226 functions) */
Duncan Sands12da8ce2009-03-07 15:45:40 +0000227 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000228 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
229 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
Duncan Sandse2881052009-03-11 08:08:06 +0000230 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000231 LLVMGhostLinkage, /**< Obsolete */
Bill Wendling002b1672009-07-20 18:22:52 +0000232 LLVMCommonLinkage, /**< Tentative definitions */
Bill Wendling03bcd6e2010-07-01 21:55:59 +0000233 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
Bill Wendling578ee402010-08-20 22:05:50 +0000234 LLVMLinkerPrivateWeakLinkage, /**< Like LinkerPrivate, but is weak. */
235 LLVMLinkerPrivateWeakDefAutoLinkage /**< Like LinkerPrivateWeak, but possibly
236 hidden. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000237} LLVMLinkage;
238
239typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000240 LLVMDefaultVisibility, /**< The GV is visible */
241 LLVMHiddenVisibility, /**< The GV is hidden */
242 LLVMProtectedVisibility /**< The GV is protected */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000243} LLVMVisibility;
244
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000245typedef enum {
246 LLVMCCallConv = 0,
247 LLVMFastCallConv = 8,
248 LLVMColdCallConv = 9,
249 LLVMX86StdcallCallConv = 64,
250 LLVMX86FastcallCallConv = 65
251} LLVMCallConv;
252
253typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000254 LLVMIntEQ = 32, /**< equal */
255 LLVMIntNE, /**< not equal */
256 LLVMIntUGT, /**< unsigned greater than */
257 LLVMIntUGE, /**< unsigned greater or equal */
258 LLVMIntULT, /**< unsigned less than */
259 LLVMIntULE, /**< unsigned less or equal */
260 LLVMIntSGT, /**< signed greater than */
261 LLVMIntSGE, /**< signed greater or equal */
262 LLVMIntSLT, /**< signed less than */
263 LLVMIntSLE /**< signed less or equal */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000264} LLVMIntPredicate;
265
266typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000267 LLVMRealPredicateFalse, /**< Always false (always folded) */
268 LLVMRealOEQ, /**< True if ordered and equal */
269 LLVMRealOGT, /**< True if ordered and greater than */
270 LLVMRealOGE, /**< True if ordered and greater than or equal */
271 LLVMRealOLT, /**< True if ordered and less than */
272 LLVMRealOLE, /**< True if ordered and less than or equal */
273 LLVMRealONE, /**< True if ordered and operands are unequal */
274 LLVMRealORD, /**< True if ordered (no nans) */
275 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
276 LLVMRealUEQ, /**< True if unordered or equal */
277 LLVMRealUGT, /**< True if unordered or greater than */
278 LLVMRealUGE, /**< True if unordered, greater than, or equal */
279 LLVMRealULT, /**< True if unordered or less than */
280 LLVMRealULE, /**< True if unordered, less than, or equal */
281 LLVMRealUNE, /**< True if unordered or not equal */
282 LLVMRealPredicateTrue /**< Always true (always folded) */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000283} LLVMRealPredicate;
284
Gordon Henriksen76a03742007-09-18 03:18:57 +0000285
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000286/*===-- Error handling ----------------------------------------------------===*/
287
288void LLVMDisposeMessage(char *Message);
289
290
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000291/*===-- Contexts ----------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000292
Owen Anderson6773d382009-07-01 16:58:40 +0000293/* Create and destroy contexts. */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000294LLVMContextRef LLVMContextCreate(void);
295LLVMContextRef LLVMGetGlobalContext(void);
Owen Anderson6773d382009-07-01 16:58:40 +0000296void LLVMContextDispose(LLVMContextRef C);
297
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000298unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
299 unsigned SLen);
300unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
301
302/*===-- Modules -----------------------------------------------------------===*/
303
Gordon Henriksen76a03742007-09-18 03:18:57 +0000304/* Create and destroy modules. */
Gordon Henriksena49d4352008-03-07 19:13:06 +0000305/** See llvm::Module::Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000306LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Owen Anderson31d44e42009-07-02 07:17:57 +0000307LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
308 LLVMContextRef C);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000309
310/** See llvm::Module::~Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000311void LLVMDisposeModule(LLVMModuleRef M);
312
Gordon Henriksena49d4352008-03-07 19:13:06 +0000313/** Data layout. See Module::getDataLayout. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000314const char *LLVMGetDataLayout(LLVMModuleRef M);
315void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
316
Gordon Henriksena49d4352008-03-07 19:13:06 +0000317/** Target triple. See Module::getTargetTriple. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000318const char *LLVMGetTarget(LLVMModuleRef M);
319void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
320
Gordon Henriksena49d4352008-03-07 19:13:06 +0000321/** See Module::addTypeName. */
Chris Lattner25963c62010-01-09 22:27:07 +0000322LLVMBool LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000323void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
Chris Lattner7f318242009-07-06 17:29:59 +0000324LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000325
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000326/** See Module::dump. */
327void LLVMDumpModule(LLVMModuleRef M);
328
Chris Lattner26941452010-04-10 17:52:58 +0000329/** See Module::setModuleInlineAsm. */
330void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000331
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000332/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000333
334/* LLVM types conform to the following hierarchy:
335 *
336 * types:
337 * integer type
338 * real type
339 * function type
340 * sequence types:
341 * array type
342 * pointer type
343 * vector type
344 * void type
345 * label type
346 * opaque type
347 */
348
Gordon Henriksena49d4352008-03-07 19:13:06 +0000349/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000350LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000351
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000352/** See llvm::LLVMType::getContext. */
353LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
354
Gordon Henriksen76a03742007-09-18 03:18:57 +0000355/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000356LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
357LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
358LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
359LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
360LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
361LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
362
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000363LLVMTypeRef LLVMInt1Type(void);
364LLVMTypeRef LLVMInt8Type(void);
365LLVMTypeRef LLVMInt16Type(void);
366LLVMTypeRef LLVMInt32Type(void);
367LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000368LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000369unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000370
371/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000372LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
373LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
374LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
375LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
376LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
377
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000378LLVMTypeRef LLVMFloatType(void);
379LLVMTypeRef LLVMDoubleType(void);
380LLVMTypeRef LLVMX86FP80Type(void);
381LLVMTypeRef LLVMFP128Type(void);
382LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000383
384/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000385LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
386 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000387 LLVMBool IsVarArg);
388LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000389LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
390unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
391void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000392
393/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000394LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000395 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000396LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000397 LLVMBool Packed);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000398unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000399void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000400LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000401
402/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000403LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000404LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000405LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000406
407LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
408unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000409unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000410unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
411
412/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000413LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
414LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
415LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000416LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000417
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000418LLVMTypeRef LLVMVoidType(void);
419LLVMTypeRef LLVMLabelType(void);
420LLVMTypeRef LLVMOpaqueType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000421LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000422
Gordon Henriksenffb48762007-10-07 00:13:35 +0000423/* Operations on type handles */
424LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
425void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
426LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
427void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
428
Gordon Henriksen76a03742007-09-18 03:18:57 +0000429
430/*===-- Values ------------------------------------------------------------===*/
431
432/* The bulk of LLVM's object model consists of values, which comprise a very
433 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000434 */
435
Gordon Henriksen29e38942008-12-19 18:39:45 +0000436#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
437 macro(Argument) \
438 macro(BasicBlock) \
439 macro(InlineAsm) \
440 macro(User) \
441 macro(Constant) \
442 macro(ConstantAggregateZero) \
443 macro(ConstantArray) \
444 macro(ConstantExpr) \
445 macro(ConstantFP) \
446 macro(ConstantInt) \
447 macro(ConstantPointerNull) \
448 macro(ConstantStruct) \
449 macro(ConstantVector) \
450 macro(GlobalValue) \
451 macro(Function) \
452 macro(GlobalAlias) \
453 macro(GlobalVariable) \
454 macro(UndefValue) \
455 macro(Instruction) \
456 macro(BinaryOperator) \
457 macro(CallInst) \
458 macro(IntrinsicInst) \
459 macro(DbgInfoIntrinsic) \
460 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000461 macro(EHSelectorInst) \
462 macro(MemIntrinsic) \
463 macro(MemCpyInst) \
464 macro(MemMoveInst) \
465 macro(MemSetInst) \
466 macro(CmpInst) \
467 macro(FCmpInst) \
468 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000469 macro(ExtractElementInst) \
470 macro(GetElementPtrInst) \
471 macro(InsertElementInst) \
472 macro(InsertValueInst) \
473 macro(PHINode) \
474 macro(SelectInst) \
475 macro(ShuffleVectorInst) \
476 macro(StoreInst) \
477 macro(TerminatorInst) \
478 macro(BranchInst) \
479 macro(InvokeInst) \
480 macro(ReturnInst) \
481 macro(SwitchInst) \
482 macro(UnreachableInst) \
483 macro(UnwindInst) \
484 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000485 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000486 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000487 macro(BitCastInst) \
488 macro(FPExtInst) \
489 macro(FPToSIInst) \
490 macro(FPToUIInst) \
491 macro(FPTruncInst) \
492 macro(IntToPtrInst) \
493 macro(PtrToIntInst) \
494 macro(SExtInst) \
495 macro(SIToFPInst) \
496 macro(TruncInst) \
497 macro(UIToFPInst) \
498 macro(ZExtInst) \
499 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000500 macro(LoadInst) \
501 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000502
Gordon Henriksen76a03742007-09-18 03:18:57 +0000503/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000504LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000505const char *LLVMGetValueName(LLVMValueRef Val);
506void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000507void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000508void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000509int LLVMHasMetadata(LLVMValueRef Val);
510LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
511void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000512
Gordon Henriksen29e38942008-12-19 18:39:45 +0000513/* Conversion functions. Return the input value if it is an instance of the
514 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
515#define LLVM_DECLARE_VALUE_CAST(name) \
516 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
517LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
518
Chris Lattner40cf28d2009-10-12 04:01:02 +0000519/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000520LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
521LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
522LLVMValueRef LLVMGetUser(LLVMUseRef U);
523LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000524
525/* Operations on Users */
526LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Erick Tryzelaarb4d48702010-08-20 14:51:22 +0000527void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
528int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000529
Gordon Henriksen76a03742007-09-18 03:18:57 +0000530/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000531LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
532LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000533LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000534LLVMBool LLVMIsConstant(LLVMValueRef Val);
535LLVMBool LLVMIsNull(LLVMValueRef Val);
536LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000537LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000538
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000539/* Operations on metadata */
540LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
541 unsigned SLen);
542LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
543LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
544 unsigned Count);
545LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
546
Gordon Henriksen76a03742007-09-18 03:18:57 +0000547/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000548LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000549 LLVMBool SignExtend);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000550LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
551 uint8_t Radix);
552LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
553 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000554LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000555LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000556LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
557 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000558unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
559long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000560
Gordon Henriksen76a03742007-09-18 03:18:57 +0000561
562/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000563LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000564 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000565LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
566 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000567 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000568
Gordon Henriksen1046c732007-10-06 15:11:06 +0000569LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000570 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000571LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000572 LLVMValueRef *ConstantVals, unsigned Length);
573LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000574 LLVMBool Packed);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000575LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000576
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000577/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000578LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000579LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000580LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
581LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000582LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
583LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000584LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000585LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
586LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000587LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000588LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000589LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000590LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000591LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
592LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000593LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000594LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000595LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
596LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000597LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000598LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
599LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000600LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000601LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
602LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
604LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
605LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
606LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
607LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
609 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
611 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
612LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
613LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
614LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
615LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
616 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000617LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
618 LLVMValueRef *ConstantIndices,
619 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000620LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
621LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
622LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
623LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
624LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
625LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
626LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
627LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
628LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
629LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
630LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
631LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000632LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
633 LLVMTypeRef ToType);
634LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
635 LLVMTypeRef ToType);
636LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
637 LLVMTypeRef ToType);
638LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
639 LLVMTypeRef ToType);
640LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000641 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000642LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000643LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
644 LLVMValueRef ConstantIfTrue,
645 LLVMValueRef ConstantIfFalse);
646LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
647 LLVMValueRef IndexConstant);
648LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
649 LLVMValueRef ElementValueConstant,
650 LLVMValueRef IndexConstant);
651LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
652 LLVMValueRef VectorBConstant,
653 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000654LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
655 unsigned NumIdx);
656LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
657 LLVMValueRef ElementValueConstant,
658 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000659LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000660 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000661 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000662LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000663
Gordon Henriksen76a03742007-09-18 03:18:57 +0000664/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000665LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000666LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000667LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
668void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
669const char *LLVMGetSection(LLVMValueRef Global);
670void LLVMSetSection(LLVMValueRef Global, const char *Section);
671LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
672void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
673unsigned LLVMGetAlignment(LLVMValueRef Global);
674void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
675
676/* Operations on global variables */
677LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000678LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
679 const char *Name,
680 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000681LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000682LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
683LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
684LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
685LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000686void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000687LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
688void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000689LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
690void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
691LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
692void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000693
Chris Lattner3d1f5522008-12-17 21:39:50 +0000694/* Operations on aliases */
695LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
696 const char *Name);
697
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000698/* Operations on functions */
699LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
700 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000701LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000702LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
703LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
704LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
705LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000706void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000707unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
708unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
709void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000710const char *LLVMGetGC(LLVMValueRef Fn);
711void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000712void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000713LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000714void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000715
Gordon Henriksen265f7802008-03-19 01:11:35 +0000716/* Operations on parameters */
717unsigned LLVMCountParams(LLVMValueRef Fn);
718void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
719LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
720LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000721LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
722LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
723LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
724LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000725void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
726void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000727LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000728void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000729
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000730/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000731LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000732LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000733LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000734LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000735unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
736void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000737LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
738LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
739LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
740LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000741LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000742
743LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
744 LLVMValueRef Fn,
745 const char *Name);
746LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
747 LLVMBasicBlockRef BB,
748 const char *Name);
749
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000750LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
751LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
752 const char *Name);
753void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
754
Duncan Sandsb1d61aa2010-07-19 15:31:07 +0000755void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
756void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
757
Gordon Henriksen265f7802008-03-19 01:11:35 +0000758/* Operations on instructions */
759LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000760LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
761LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
762LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
763LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000764
Gordon Henriksen1158c532007-12-29 20:45:00 +0000765/* Operations on call sites */
766void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
767unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000768void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
769void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
770 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000771void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
772 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000773
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000774/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000775LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
776void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000777
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000778/* Operations on phi nodes */
779void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
780 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
781unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
782LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
783LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000784
785/*===-- Instruction builders ----------------------------------------------===*/
786
787/* An instruction builder represents a point within a basic block, and is the
788 * exclusive means of building instructions using the C interface.
789 */
790
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000791LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000792LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000793void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
794 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000795void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
796void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000797LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000798void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
799void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000800void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
801 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000802void LLVMDisposeBuilder(LLVMBuilderRef Builder);
803
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000804/* Metadata */
805void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
806LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
807void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
808
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000809/* Terminators */
810LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
811LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000812LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000813 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000814LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
815LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
816 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
817LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
818 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000819LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
820 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000821LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
822 LLVMValueRef *Args, unsigned NumArgs,
823 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
824 const char *Name);
825LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
826LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
827
Gordon Henriksen097102c2008-01-01 05:50:53 +0000828/* Add a case to the switch instruction */
829void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
830 LLVMBasicBlockRef Dest);
831
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000832/* Add a destination to the indirectbr instruction */
833void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
834
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000835/* Arithmetic */
836LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
837 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000838LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
839 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000840LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
841 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000842LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
843 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000844LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
845 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000846LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
847 const char *Name);
848LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
849 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000850LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
851 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000852LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
853 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000854LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
855 const char *Name);
856LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
857 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000858LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
859 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000860LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
861 const char *Name);
862LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
863 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000864LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
865 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000866LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
867 const char *Name);
868LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
869 const char *Name);
870LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
871 const char *Name);
872LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
873 const char *Name);
874LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
875 const char *Name);
876LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
877 const char *Name);
878LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
879 const char *Name);
880LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
881 const char *Name);
882LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
883 const char *Name);
884LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
885 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000886LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
887 LLVMValueRef LHS, LLVMValueRef RHS,
888 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000889LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000890LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
891 const char *Name);
892LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
893 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000894LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000895LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
896
897/* Memory */
898LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
899LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
900 LLVMValueRef Val, const char *Name);
901LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
902LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
903 LLVMValueRef Val, const char *Name);
904LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
905LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
906 const char *Name);
907LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
908LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
909 LLVMValueRef *Indices, unsigned NumIndices,
910 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000911LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
912 LLVMValueRef *Indices, unsigned NumIndices,
913 const char *Name);
914LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
915 unsigned Idx, const char *Name);
916LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
917 const char *Name);
918LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
919 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000920
921/* Casts */
922LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
923 LLVMTypeRef DestTy, const char *Name);
924LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
925 LLVMTypeRef DestTy, const char *Name);
926LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
927 LLVMTypeRef DestTy, const char *Name);
928LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
929 LLVMTypeRef DestTy, const char *Name);
930LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
931 LLVMTypeRef DestTy, const char *Name);
932LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
933 LLVMTypeRef DestTy, const char *Name);
934LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
935 LLVMTypeRef DestTy, const char *Name);
936LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
937 LLVMTypeRef DestTy, const char *Name);
938LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
939 LLVMTypeRef DestTy, const char *Name);
940LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
941 LLVMTypeRef DestTy, const char *Name);
942LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
943 LLVMTypeRef DestTy, const char *Name);
944LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
945 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000946LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
947 LLVMTypeRef DestTy, const char *Name);
948LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
949 LLVMTypeRef DestTy, const char *Name);
950LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
951 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000952LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
953 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000954LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
955 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000956LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000957 LLVMTypeRef DestTy, const char *Name);
958LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
959 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000960
961/* Comparisons */
962LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
963 LLVMValueRef LHS, LLVMValueRef RHS,
964 const char *Name);
965LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
966 LLVMValueRef LHS, LLVMValueRef RHS,
967 const char *Name);
968
969/* Miscellaneous instructions */
970LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
971LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
972 LLVMValueRef *Args, unsigned NumArgs,
973 const char *Name);
974LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
975 LLVMValueRef Then, LLVMValueRef Else,
976 const char *Name);
977LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
978 const char *Name);
979LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
980 LLVMValueRef Index, const char *Name);
981LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
982 LLVMValueRef EltVal, LLVMValueRef Index,
983 const char *Name);
984LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
985 LLVMValueRef V2, LLVMValueRef Mask,
986 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000987LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
988 unsigned Index, const char *Name);
989LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
990 LLVMValueRef EltVal, unsigned Index,
991 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000992
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000993LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
994 const char *Name);
995LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
996 const char *Name);
997LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
998 LLVMValueRef RHS, const char *Name);
999
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001000
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001001/*===-- Module providers --------------------------------------------------===*/
1002
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001003/* Changes the type of M so it can be passed to FunctionPassManagers and the
1004 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001005 */
1006LLVMModuleProviderRef
1007LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1008
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001009/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001010 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001011void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001012
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001013
1014/*===-- Memory buffers ----------------------------------------------------===*/
1015
Chris Lattner25963c62010-01-09 22:27:07 +00001016LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1017 LLVMMemoryBufferRef *OutMemBuf,
1018 char **OutMessage);
1019LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1020 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001021void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1022
Owen Anderson4698c5d2010-10-07 17:55:47 +00001023/*===-- Pass Registry -----------------------------------------------------===*/
1024
1025/** Return the global pass registry, for use with initialization functions.
1026 See llvm::PassRegistry::getPassRegistry. */
1027LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001028
1029/*===-- Pass Managers -----------------------------------------------------===*/
1030
1031/** Constructs a new whole-module pass pipeline. This type of pipeline is
1032 suitable for link-time optimization and whole-module transformations.
1033 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001034LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001035
1036/** Constructs a new function-by-function pass pipeline over the module
1037 provider. It does not take ownership of the module provider. This type of
1038 pipeline is suitable for code generation and JIT compilation tasks.
1039 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001040LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1041
1042/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001043LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1044
1045/** Initializes, executes on the provided module, and finalizes all of the
1046 passes scheduled in the pass manager. Returns 1 if any of the passes
1047 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001048LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001049
1050/** Initializes all of the function passes scheduled in the function pass
1051 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1052 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001053LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001054
1055/** Executes all of the function passes scheduled in the function pass manager
1056 on the provided function. Returns 1 if any of the passes modified the
1057 function, false otherwise.
1058 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001059LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001060
1061/** Finalizes all of the function passes scheduled in in the function pass
1062 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1063 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001064LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001065
1066/** Frees the memory of a pass pipeline. For function pipelines, does not free
1067 the module provider.
1068 See llvm::PassManagerBase::~PassManagerBase. */
1069void LLVMDisposePassManager(LLVMPassManagerRef PM);
1070
1071
Gordon Henriksen76a03742007-09-18 03:18:57 +00001072#ifdef __cplusplus
1073}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001074
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001075namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001076 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001077 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001078
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001079 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1080 inline ty *unwrap(ref P) { \
1081 return reinterpret_cast<ty*>(P); \
1082 } \
1083 \
1084 inline ref wrap(const ty *P) { \
1085 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1086 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001087
Gordon Henriksen878114b2008-03-16 04:20:44 +00001088 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1089 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1090 \
1091 template<typename T> \
1092 inline T *unwrap(ref P) { \
1093 return cast<T>(unwrap(P)); \
1094 }
1095
1096 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1097 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1098 \
1099 template<typename T> \
1100 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001101 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001102 assert(Q && "Invalid cast!"); \
1103 return Q; \
1104 }
1105
1106 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1107 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001108 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1109 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001110 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001111 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001112 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001113 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001114 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001115 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Owen Anderson4698c5d2010-10-07 17:55:47 +00001116 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001117 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1118 * Module.
1119 */
1120 inline Module *unwrap(LLVMModuleProviderRef MP) {
1121 return reinterpret_cast<Module*>(MP);
1122 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001123
Gordon Henriksen878114b2008-03-16 04:20:44 +00001124 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1125 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001126 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001127
1128 /* Specialized opaque context conversions.
1129 */
1130 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1131 return reinterpret_cast<LLVMContext**>(Tys);
1132 }
1133
1134 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1135 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1136 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001137
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001138 /* Specialized opaque type conversions.
1139 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001140 inline Type **unwrap(LLVMTypeRef* Tys) {
1141 return reinterpret_cast<Type**>(Tys);
1142 }
1143
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001144 inline LLVMTypeRef *wrap(const Type **Tys) {
1145 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1146 }
1147
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001148 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001149 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001150 inline Value **unwrap(LLVMValueRef *Vals) {
1151 return reinterpret_cast<Value**>(Vals);
1152 }
1153
1154 template<typename T>
1155 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1156 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001157 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001158 cast<T>(*I);
1159 #endif
1160 return reinterpret_cast<T**>(Vals);
1161 }
1162
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001163 inline LLVMValueRef *wrap(const Value **Vals) {
1164 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1165 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001166}
1167
1168#endif /* !defined(__cplusplus) */
1169
1170#endif /* !defined(LLVM_C_CORE_H) */