blob: 39c3cb40117c1554ed7aae7f01137cd52fe658a4 [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
Michael J. Spencerab425d82010-11-29 18:47:54 +000036#include "llvm/Support/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);
Rafael Espindola7c0cb2b2011-02-18 16:35:37 +0000325const char *LLVMGetTypeName(LLVMModuleRef M, LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000326
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000327/** See Module::dump. */
328void LLVMDumpModule(LLVMModuleRef M);
329
Chris Lattner26941452010-04-10 17:52:58 +0000330/** See Module::setModuleInlineAsm. */
331void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000332
Chris Lattnera7e04b02010-11-28 20:03:44 +0000333/** See Module::getContext. */
334LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
335
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000336/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000337
338/* LLVM types conform to the following hierarchy:
339 *
340 * types:
341 * integer type
342 * real type
343 * function type
344 * sequence types:
345 * array type
346 * pointer type
347 * vector type
348 * void type
349 * label type
350 * opaque type
351 */
352
Gordon Henriksena49d4352008-03-07 19:13:06 +0000353/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000354LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000355
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000356/** See llvm::LLVMType::getContext. */
357LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
358
Gordon Henriksen76a03742007-09-18 03:18:57 +0000359/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000360LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
361LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
362LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
363LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
364LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
365LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
366
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000367LLVMTypeRef LLVMInt1Type(void);
368LLVMTypeRef LLVMInt8Type(void);
369LLVMTypeRef LLVMInt16Type(void);
370LLVMTypeRef LLVMInt32Type(void);
371LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000372LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000373unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000374
375/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000376LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
377LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
378LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
379LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
380LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
381
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000382LLVMTypeRef LLVMFloatType(void);
383LLVMTypeRef LLVMDoubleType(void);
384LLVMTypeRef LLVMX86FP80Type(void);
385LLVMTypeRef LLVMFP128Type(void);
386LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000387
388/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000389LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
390 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000391 LLVMBool IsVarArg);
392LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000393LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
394unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
395void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000396
397/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000398LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000399 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000400LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000401 LLVMBool Packed);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000402unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000403void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000404LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000405
406/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000407LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000408LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000409LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000410
411LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
412unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000413unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000414unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
415
416/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000417LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
418LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
419LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000420LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000421
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000422LLVMTypeRef LLVMVoidType(void);
423LLVMTypeRef LLVMLabelType(void);
424LLVMTypeRef LLVMOpaqueType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000425LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000426
Gordon Henriksenffb48762007-10-07 00:13:35 +0000427/* Operations on type handles */
428LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
429void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
430LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
431void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
432
Gordon Henriksen76a03742007-09-18 03:18:57 +0000433
434/*===-- Values ------------------------------------------------------------===*/
435
436/* The bulk of LLVM's object model consists of values, which comprise a very
437 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000438 */
439
Gordon Henriksen29e38942008-12-19 18:39:45 +0000440#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
441 macro(Argument) \
442 macro(BasicBlock) \
443 macro(InlineAsm) \
444 macro(User) \
445 macro(Constant) \
446 macro(ConstantAggregateZero) \
447 macro(ConstantArray) \
448 macro(ConstantExpr) \
449 macro(ConstantFP) \
450 macro(ConstantInt) \
451 macro(ConstantPointerNull) \
452 macro(ConstantStruct) \
453 macro(ConstantVector) \
454 macro(GlobalValue) \
455 macro(Function) \
456 macro(GlobalAlias) \
457 macro(GlobalVariable) \
458 macro(UndefValue) \
459 macro(Instruction) \
460 macro(BinaryOperator) \
461 macro(CallInst) \
462 macro(IntrinsicInst) \
463 macro(DbgInfoIntrinsic) \
464 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000465 macro(EHSelectorInst) \
466 macro(MemIntrinsic) \
467 macro(MemCpyInst) \
468 macro(MemMoveInst) \
469 macro(MemSetInst) \
470 macro(CmpInst) \
471 macro(FCmpInst) \
472 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000473 macro(ExtractElementInst) \
474 macro(GetElementPtrInst) \
475 macro(InsertElementInst) \
476 macro(InsertValueInst) \
477 macro(PHINode) \
478 macro(SelectInst) \
479 macro(ShuffleVectorInst) \
480 macro(StoreInst) \
481 macro(TerminatorInst) \
482 macro(BranchInst) \
483 macro(InvokeInst) \
484 macro(ReturnInst) \
485 macro(SwitchInst) \
486 macro(UnreachableInst) \
487 macro(UnwindInst) \
488 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000489 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000490 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000491 macro(BitCastInst) \
492 macro(FPExtInst) \
493 macro(FPToSIInst) \
494 macro(FPToUIInst) \
495 macro(FPTruncInst) \
496 macro(IntToPtrInst) \
497 macro(PtrToIntInst) \
498 macro(SExtInst) \
499 macro(SIToFPInst) \
500 macro(TruncInst) \
501 macro(UIToFPInst) \
502 macro(ZExtInst) \
503 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000504 macro(LoadInst) \
505 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000506
Gordon Henriksen76a03742007-09-18 03:18:57 +0000507/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000508LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000509const char *LLVMGetValueName(LLVMValueRef Val);
510void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000511void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000512void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000513int LLVMHasMetadata(LLVMValueRef Val);
514LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
515void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000516
Gordon Henriksen29e38942008-12-19 18:39:45 +0000517/* Conversion functions. Return the input value if it is an instance of the
518 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
519#define LLVM_DECLARE_VALUE_CAST(name) \
520 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
521LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
522
Chris Lattner40cf28d2009-10-12 04:01:02 +0000523/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000524LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
525LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
526LLVMValueRef LLVMGetUser(LLVMUseRef U);
527LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000528
529/* Operations on Users */
530LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Erick Tryzelaarb4d48702010-08-20 14:51:22 +0000531void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
532int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000533
Gordon Henriksen76a03742007-09-18 03:18:57 +0000534/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000535LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
536LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000537LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000538LLVMBool LLVMIsConstant(LLVMValueRef Val);
539LLVMBool LLVMIsNull(LLVMValueRef Val);
540LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000541LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000542
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000543/* Operations on metadata */
544LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
545 unsigned SLen);
546LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
547LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
548 unsigned Count);
549LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
550
Gordon Henriksen76a03742007-09-18 03:18:57 +0000551/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000552LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000553 LLVMBool SignExtend);
Chris Lattner4329e072010-11-23 02:47:22 +0000554LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
555 unsigned NumWords,
556 const uint64_t Words[]);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000557LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
558 uint8_t Radix);
559LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
560 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000561LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000562LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000563LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
564 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000565unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
566long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000567
Gordon Henriksen76a03742007-09-18 03:18:57 +0000568
569/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000570LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000571 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000572LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
573 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000574 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000575
Gordon Henriksen1046c732007-10-06 15:11:06 +0000576LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000577 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000578LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000579 LLVMValueRef *ConstantVals, unsigned Length);
580LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000581 LLVMBool Packed);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000582LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000583
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000584/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000585LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000586LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000587LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
588LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000589LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
590LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000591LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000592LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
593LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000594LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000595LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000596LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000597LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000598LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
599LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000600LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000601LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000602LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000604LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000605LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
606LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000607LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000608LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
609LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
611LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
612LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
613LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
614LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
615LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
616 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
617LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
618 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
619LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
620LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
621LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
622LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
623 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000624LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
625 LLVMValueRef *ConstantIndices,
626 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000627LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
628LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
629LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
630LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
631LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
632LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
633LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
634LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
635LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
636LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
637LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
638LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000639LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
640 LLVMTypeRef ToType);
641LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
642 LLVMTypeRef ToType);
643LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
644 LLVMTypeRef ToType);
645LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
646 LLVMTypeRef ToType);
647LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000648 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000649LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000650LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
651 LLVMValueRef ConstantIfTrue,
652 LLVMValueRef ConstantIfFalse);
653LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
654 LLVMValueRef IndexConstant);
655LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
656 LLVMValueRef ElementValueConstant,
657 LLVMValueRef IndexConstant);
658LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
659 LLVMValueRef VectorBConstant,
660 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000661LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
662 unsigned NumIdx);
663LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
664 LLVMValueRef ElementValueConstant,
665 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000666LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000667 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000668 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000669LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000670
Gordon Henriksen76a03742007-09-18 03:18:57 +0000671/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000672LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000673LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000674LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
675void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
676const char *LLVMGetSection(LLVMValueRef Global);
677void LLVMSetSection(LLVMValueRef Global, const char *Section);
678LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
679void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
680unsigned LLVMGetAlignment(LLVMValueRef Global);
681void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
682
683/* Operations on global variables */
684LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000685LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
686 const char *Name,
687 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000688LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000689LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
690LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
691LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
692LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000693void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000694LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
695void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000696LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
697void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
698LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
699void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000700
Chris Lattner3d1f5522008-12-17 21:39:50 +0000701/* Operations on aliases */
702LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
703 const char *Name);
704
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000705/* Operations on functions */
706LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
707 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000708LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000709LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
710LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
711LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
712LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000713void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000714unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
715unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
716void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000717const char *LLVMGetGC(LLVMValueRef Fn);
718void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000719void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000720LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000721void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000722
Gordon Henriksen265f7802008-03-19 01:11:35 +0000723/* Operations on parameters */
724unsigned LLVMCountParams(LLVMValueRef Fn);
725void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
726LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
727LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000728LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
729LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
730LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
731LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000732void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
733void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000734LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000735void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000736
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000737/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000738LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000739LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000740LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000741LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000742unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
743void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000744LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
745LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
746LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
747LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000748LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000749
750LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
751 LLVMValueRef Fn,
752 const char *Name);
753LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
754 LLVMBasicBlockRef BB,
755 const char *Name);
756
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000757LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
758LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
759 const char *Name);
760void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
761
Duncan Sandsb1d61aa2010-07-19 15:31:07 +0000762void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
763void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
764
Gordon Henriksen265f7802008-03-19 01:11:35 +0000765/* Operations on instructions */
766LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000767LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
768LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
769LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
770LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000771
Gordon Henriksen1158c532007-12-29 20:45:00 +0000772/* Operations on call sites */
773void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
774unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000775void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
776void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
777 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000778void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
779 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000780
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000781/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000782LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
783void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000784
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000785/* Operations on phi nodes */
786void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
787 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
788unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
789LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
790LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000791
792/*===-- Instruction builders ----------------------------------------------===*/
793
794/* An instruction builder represents a point within a basic block, and is the
795 * exclusive means of building instructions using the C interface.
796 */
797
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000798LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000799LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000800void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
801 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000802void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
803void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000804LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000805void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
806void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000807void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
808 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000809void LLVMDisposeBuilder(LLVMBuilderRef Builder);
810
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000811/* Metadata */
812void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
813LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
814void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
815
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000816/* Terminators */
817LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
818LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000819LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000820 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000821LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
822LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
823 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
824LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
825 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000826LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
827 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000828LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
829 LLVMValueRef *Args, unsigned NumArgs,
830 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
831 const char *Name);
832LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
833LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
834
Gordon Henriksen097102c2008-01-01 05:50:53 +0000835/* Add a case to the switch instruction */
836void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
837 LLVMBasicBlockRef Dest);
838
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000839/* Add a destination to the indirectbr instruction */
840void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
841
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000842/* Arithmetic */
843LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
844 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000845LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
846 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000847LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
848 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000849LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
850 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000851LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
852 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000853LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
854 const char *Name);
855LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
856 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000857LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
858 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000859LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
860 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000861LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
862 const char *Name);
863LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
864 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000865LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
866 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000867LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
868 const char *Name);
869LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
870 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000871LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
872 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000873LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
874 const char *Name);
875LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
876 const char *Name);
877LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
878 const char *Name);
879LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
880 const char *Name);
881LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
882 const char *Name);
883LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
884 const char *Name);
885LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
886 const char *Name);
887LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
888 const char *Name);
889LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
890 const char *Name);
891LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
892 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000893LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
894 LLVMValueRef LHS, LLVMValueRef RHS,
895 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000896LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000897LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
898 const char *Name);
899LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
900 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000901LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000902LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
903
904/* Memory */
905LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
906LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
907 LLVMValueRef Val, const char *Name);
908LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
909LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
910 LLVMValueRef Val, const char *Name);
911LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
912LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
913 const char *Name);
914LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
915LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
916 LLVMValueRef *Indices, unsigned NumIndices,
917 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000918LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
919 LLVMValueRef *Indices, unsigned NumIndices,
920 const char *Name);
921LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
922 unsigned Idx, const char *Name);
923LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
924 const char *Name);
925LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
926 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000927
928/* Casts */
929LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
930 LLVMTypeRef DestTy, const char *Name);
931LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
932 LLVMTypeRef DestTy, const char *Name);
933LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
934 LLVMTypeRef DestTy, const char *Name);
935LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
936 LLVMTypeRef DestTy, const char *Name);
937LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
938 LLVMTypeRef DestTy, const char *Name);
939LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
940 LLVMTypeRef DestTy, const char *Name);
941LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
942 LLVMTypeRef DestTy, const char *Name);
943LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
944 LLVMTypeRef DestTy, const char *Name);
945LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
946 LLVMTypeRef DestTy, const char *Name);
947LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
948 LLVMTypeRef DestTy, const char *Name);
949LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
950 LLVMTypeRef DestTy, const char *Name);
951LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
952 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000953LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
954 LLVMTypeRef DestTy, const char *Name);
955LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
956 LLVMTypeRef DestTy, const char *Name);
957LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
958 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000959LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
960 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000961LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
962 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000963LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000964 LLVMTypeRef DestTy, const char *Name);
965LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
966 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000967
968/* Comparisons */
969LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
970 LLVMValueRef LHS, LLVMValueRef RHS,
971 const char *Name);
972LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
973 LLVMValueRef LHS, LLVMValueRef RHS,
974 const char *Name);
975
976/* Miscellaneous instructions */
977LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
978LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
979 LLVMValueRef *Args, unsigned NumArgs,
980 const char *Name);
981LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
982 LLVMValueRef Then, LLVMValueRef Else,
983 const char *Name);
984LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
985 const char *Name);
986LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
987 LLVMValueRef Index, const char *Name);
988LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
989 LLVMValueRef EltVal, LLVMValueRef Index,
990 const char *Name);
991LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
992 LLVMValueRef V2, LLVMValueRef Mask,
993 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000994LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
995 unsigned Index, const char *Name);
996LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
997 LLVMValueRef EltVal, unsigned Index,
998 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000999
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00001000LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
1001 const char *Name);
1002LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
1003 const char *Name);
1004LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
1005 LLVMValueRef RHS, const char *Name);
1006
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001007
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001008/*===-- Module providers --------------------------------------------------===*/
1009
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001010/* Changes the type of M so it can be passed to FunctionPassManagers and the
1011 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001012 */
1013LLVMModuleProviderRef
1014LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1015
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001016/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001017 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001018void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001019
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001020
1021/*===-- Memory buffers ----------------------------------------------------===*/
1022
Chris Lattner25963c62010-01-09 22:27:07 +00001023LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1024 LLVMMemoryBufferRef *OutMemBuf,
1025 char **OutMessage);
1026LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1027 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001028void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1029
Owen Anderson4698c5d2010-10-07 17:55:47 +00001030/*===-- Pass Registry -----------------------------------------------------===*/
1031
1032/** Return the global pass registry, for use with initialization functions.
1033 See llvm::PassRegistry::getPassRegistry. */
1034LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001035
1036/*===-- Pass Managers -----------------------------------------------------===*/
1037
1038/** Constructs a new whole-module pass pipeline. This type of pipeline is
1039 suitable for link-time optimization and whole-module transformations.
1040 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001041LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001042
1043/** Constructs a new function-by-function pass pipeline over the module
1044 provider. It does not take ownership of the module provider. This type of
1045 pipeline is suitable for code generation and JIT compilation tasks.
1046 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001047LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1048
1049/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001050LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1051
1052/** Initializes, executes on the provided module, and finalizes all of the
1053 passes scheduled in the pass manager. Returns 1 if any of the passes
1054 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001055LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001056
1057/** Initializes all of the function passes scheduled in the function pass
1058 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1059 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001060LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001061
1062/** Executes all of the function passes scheduled in the function pass manager
1063 on the provided function. Returns 1 if any of the passes modified the
1064 function, false otherwise.
1065 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001066LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001067
1068/** Finalizes all of the function passes scheduled in in the function pass
1069 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1070 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001071LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001072
1073/** Frees the memory of a pass pipeline. For function pipelines, does not free
1074 the module provider.
1075 See llvm::PassManagerBase::~PassManagerBase. */
1076void LLVMDisposePassManager(LLVMPassManagerRef PM);
1077
1078
Gordon Henriksen76a03742007-09-18 03:18:57 +00001079#ifdef __cplusplus
1080}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001081
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001082namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001083 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001084 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001085
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001086 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1087 inline ty *unwrap(ref P) { \
1088 return reinterpret_cast<ty*>(P); \
1089 } \
1090 \
1091 inline ref wrap(const ty *P) { \
1092 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1093 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001094
Gordon Henriksen878114b2008-03-16 04:20:44 +00001095 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1096 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1097 \
1098 template<typename T> \
1099 inline T *unwrap(ref P) { \
1100 return cast<T>(unwrap(P)); \
1101 }
1102
1103 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1104 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1105 \
1106 template<typename T> \
1107 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001108 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001109 assert(Q && "Invalid cast!"); \
1110 return Q; \
1111 }
1112
1113 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1114 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001115 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1116 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001117 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001118 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001119 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001120 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001121 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001122 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Owen Anderson4698c5d2010-10-07 17:55:47 +00001123 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001124 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1125 * Module.
1126 */
1127 inline Module *unwrap(LLVMModuleProviderRef MP) {
1128 return reinterpret_cast<Module*>(MP);
1129 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001130
Gordon Henriksen878114b2008-03-16 04:20:44 +00001131 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1132 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001133 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001134
1135 /* Specialized opaque context conversions.
1136 */
1137 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1138 return reinterpret_cast<LLVMContext**>(Tys);
1139 }
1140
1141 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1142 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1143 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001144
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001145 /* Specialized opaque type conversions.
1146 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001147 inline Type **unwrap(LLVMTypeRef* Tys) {
1148 return reinterpret_cast<Type**>(Tys);
1149 }
1150
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001151 inline LLVMTypeRef *wrap(const Type **Tys) {
1152 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1153 }
1154
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001155 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001156 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001157 inline Value **unwrap(LLVMValueRef *Vals) {
1158 return reinterpret_cast<Value**>(Vals);
1159 }
1160
1161 template<typename T>
1162 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1163 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001164 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001165 cast<T>(*I);
1166 #endif
1167 return reinterpret_cast<T**>(Vals);
1168 }
1169
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001170 inline LLVMValueRef *wrap(const Value **Vals) {
1171 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1172 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001173}
1174
1175#endif /* !defined(__cplusplus) */
1176
1177#endif /* !defined(LLVM_C_CORE_H) */