blob: d8a491d82be4c242b7f7e84876ad00458b529fec [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);
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
Chris Lattnera7e04b02010-11-28 20:03:44 +0000332/** See Module::getContext. */
333LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
334
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000335/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000336
337/* LLVM types conform to the following hierarchy:
338 *
339 * types:
340 * integer type
341 * real type
342 * function type
343 * sequence types:
344 * array type
345 * pointer type
346 * vector type
347 * void type
348 * label type
349 * opaque type
350 */
351
Gordon Henriksena49d4352008-03-07 19:13:06 +0000352/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000353LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000354
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000355/** See llvm::LLVMType::getContext. */
356LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
357
Gordon Henriksen76a03742007-09-18 03:18:57 +0000358/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000359LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
360LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
361LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
362LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
363LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
364LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
365
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000366LLVMTypeRef LLVMInt1Type(void);
367LLVMTypeRef LLVMInt8Type(void);
368LLVMTypeRef LLVMInt16Type(void);
369LLVMTypeRef LLVMInt32Type(void);
370LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000371LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000372unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000373
374/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000375LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
376LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
377LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
378LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
379LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
380
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000381LLVMTypeRef LLVMFloatType(void);
382LLVMTypeRef LLVMDoubleType(void);
383LLVMTypeRef LLVMX86FP80Type(void);
384LLVMTypeRef LLVMFP128Type(void);
385LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000386
387/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000388LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
389 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000390 LLVMBool IsVarArg);
391LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000392LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
393unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
394void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000395
396/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000397LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000398 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000399LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000400 LLVMBool Packed);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000401unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000402void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000403LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000404
405/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000406LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000407LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000408LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000409
410LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
411unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000412unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000413unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
414
415/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000416LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
417LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
418LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000419LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000420
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000421LLVMTypeRef LLVMVoidType(void);
422LLVMTypeRef LLVMLabelType(void);
423LLVMTypeRef LLVMOpaqueType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000424LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000425
Gordon Henriksenffb48762007-10-07 00:13:35 +0000426/* Operations on type handles */
427LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
428void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
429LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
430void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
431
Gordon Henriksen76a03742007-09-18 03:18:57 +0000432
433/*===-- Values ------------------------------------------------------------===*/
434
435/* The bulk of LLVM's object model consists of values, which comprise a very
436 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000437 */
438
Gordon Henriksen29e38942008-12-19 18:39:45 +0000439#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
440 macro(Argument) \
441 macro(BasicBlock) \
442 macro(InlineAsm) \
443 macro(User) \
444 macro(Constant) \
445 macro(ConstantAggregateZero) \
446 macro(ConstantArray) \
447 macro(ConstantExpr) \
448 macro(ConstantFP) \
449 macro(ConstantInt) \
450 macro(ConstantPointerNull) \
451 macro(ConstantStruct) \
452 macro(ConstantVector) \
453 macro(GlobalValue) \
454 macro(Function) \
455 macro(GlobalAlias) \
456 macro(GlobalVariable) \
457 macro(UndefValue) \
458 macro(Instruction) \
459 macro(BinaryOperator) \
460 macro(CallInst) \
461 macro(IntrinsicInst) \
462 macro(DbgInfoIntrinsic) \
463 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000464 macro(EHSelectorInst) \
465 macro(MemIntrinsic) \
466 macro(MemCpyInst) \
467 macro(MemMoveInst) \
468 macro(MemSetInst) \
469 macro(CmpInst) \
470 macro(FCmpInst) \
471 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000472 macro(ExtractElementInst) \
473 macro(GetElementPtrInst) \
474 macro(InsertElementInst) \
475 macro(InsertValueInst) \
476 macro(PHINode) \
477 macro(SelectInst) \
478 macro(ShuffleVectorInst) \
479 macro(StoreInst) \
480 macro(TerminatorInst) \
481 macro(BranchInst) \
482 macro(InvokeInst) \
483 macro(ReturnInst) \
484 macro(SwitchInst) \
485 macro(UnreachableInst) \
486 macro(UnwindInst) \
487 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000488 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000489 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000490 macro(BitCastInst) \
491 macro(FPExtInst) \
492 macro(FPToSIInst) \
493 macro(FPToUIInst) \
494 macro(FPTruncInst) \
495 macro(IntToPtrInst) \
496 macro(PtrToIntInst) \
497 macro(SExtInst) \
498 macro(SIToFPInst) \
499 macro(TruncInst) \
500 macro(UIToFPInst) \
501 macro(ZExtInst) \
502 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000503 macro(LoadInst) \
504 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000505
Gordon Henriksen76a03742007-09-18 03:18:57 +0000506/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000507LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000508const char *LLVMGetValueName(LLVMValueRef Val);
509void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000510void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000511void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000512int LLVMHasMetadata(LLVMValueRef Val);
513LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
514void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000515
Gordon Henriksen29e38942008-12-19 18:39:45 +0000516/* Conversion functions. Return the input value if it is an instance of the
517 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
518#define LLVM_DECLARE_VALUE_CAST(name) \
519 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
520LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
521
Chris Lattner40cf28d2009-10-12 04:01:02 +0000522/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000523LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
524LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
525LLVMValueRef LLVMGetUser(LLVMUseRef U);
526LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000527
528/* Operations on Users */
529LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Erick Tryzelaarb4d48702010-08-20 14:51:22 +0000530void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
531int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000532
Gordon Henriksen76a03742007-09-18 03:18:57 +0000533/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000534LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
535LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000536LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000537LLVMBool LLVMIsConstant(LLVMValueRef Val);
538LLVMBool LLVMIsNull(LLVMValueRef Val);
539LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000540LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000541
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000542/* Operations on metadata */
543LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
544 unsigned SLen);
545LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
546LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
547 unsigned Count);
548LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
549
Gordon Henriksen76a03742007-09-18 03:18:57 +0000550/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000551LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000552 LLVMBool SignExtend);
Chris Lattner4329e072010-11-23 02:47:22 +0000553LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
554 unsigned NumWords,
555 const uint64_t Words[]);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000556LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
557 uint8_t Radix);
558LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
559 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000560LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000561LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000562LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
563 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000564unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
565long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000566
Gordon Henriksen76a03742007-09-18 03:18:57 +0000567
568/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000569LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000570 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000571LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
572 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000573 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000574
Gordon Henriksen1046c732007-10-06 15:11:06 +0000575LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000576 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000577LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000578 LLVMValueRef *ConstantVals, unsigned Length);
579LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000580 LLVMBool Packed);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000581LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000582
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000583/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000584LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000585LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000586LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
587LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000588LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
589LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000590LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000591LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
592LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000593LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000594LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000595LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000596LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000597LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
598LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000599LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000600LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000601LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
602LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000603LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000604LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
605LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000606LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000607LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
609LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
611LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
612LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
613LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
614LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
615 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
616LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
617 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
618LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
619LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
620LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
621LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
622 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000623LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
624 LLVMValueRef *ConstantIndices,
625 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000626LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
627LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
628LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
629LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
630LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
631LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
632LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
633LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
634LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
635LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
636LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
637LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000638LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
639 LLVMTypeRef ToType);
640LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
641 LLVMTypeRef ToType);
642LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
643 LLVMTypeRef ToType);
644LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
645 LLVMTypeRef ToType);
646LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000647 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000648LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000649LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
650 LLVMValueRef ConstantIfTrue,
651 LLVMValueRef ConstantIfFalse);
652LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
653 LLVMValueRef IndexConstant);
654LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
655 LLVMValueRef ElementValueConstant,
656 LLVMValueRef IndexConstant);
657LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
658 LLVMValueRef VectorBConstant,
659 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000660LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
661 unsigned NumIdx);
662LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
663 LLVMValueRef ElementValueConstant,
664 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000665LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000666 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000667 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000668LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000669
Gordon Henriksen76a03742007-09-18 03:18:57 +0000670/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000671LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000672LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000673LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
674void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
675const char *LLVMGetSection(LLVMValueRef Global);
676void LLVMSetSection(LLVMValueRef Global, const char *Section);
677LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
678void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
679unsigned LLVMGetAlignment(LLVMValueRef Global);
680void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
681
682/* Operations on global variables */
683LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000684LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
685 const char *Name,
686 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000687LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000688LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
689LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
690LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
691LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000692void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000693LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
694void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000695LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
696void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
697LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
698void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000699
Chris Lattner3d1f5522008-12-17 21:39:50 +0000700/* Operations on aliases */
701LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
702 const char *Name);
703
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000704/* Operations on functions */
705LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
706 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000707LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000708LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
709LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
710LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
711LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000712void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000713unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
714unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
715void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000716const char *LLVMGetGC(LLVMValueRef Fn);
717void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000718void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000719LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000720void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000721
Gordon Henriksen265f7802008-03-19 01:11:35 +0000722/* Operations on parameters */
723unsigned LLVMCountParams(LLVMValueRef Fn);
724void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
725LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
726LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000727LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
728LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
729LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
730LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000731void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
732void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000733LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000734void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000735
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000736/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000737LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000738LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000739LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000740LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000741unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
742void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000743LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
744LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
745LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
746LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000747LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000748
749LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
750 LLVMValueRef Fn,
751 const char *Name);
752LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
753 LLVMBasicBlockRef BB,
754 const char *Name);
755
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000756LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
757LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
758 const char *Name);
759void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
760
Duncan Sandsb1d61aa2010-07-19 15:31:07 +0000761void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
762void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
763
Gordon Henriksen265f7802008-03-19 01:11:35 +0000764/* Operations on instructions */
765LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000766LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
767LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
768LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
769LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000770
Gordon Henriksen1158c532007-12-29 20:45:00 +0000771/* Operations on call sites */
772void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
773unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000774void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
775void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
776 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000777void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
778 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000779
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000780/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000781LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
782void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000783
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000784/* Operations on phi nodes */
785void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
786 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
787unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
788LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
789LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000790
791/*===-- Instruction builders ----------------------------------------------===*/
792
793/* An instruction builder represents a point within a basic block, and is the
794 * exclusive means of building instructions using the C interface.
795 */
796
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000797LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000798LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000799void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
800 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000801void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
802void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000803LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000804void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
805void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000806void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
807 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000808void LLVMDisposeBuilder(LLVMBuilderRef Builder);
809
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000810/* Metadata */
811void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
812LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
813void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
814
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000815/* Terminators */
816LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
817LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000818LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000819 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000820LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
821LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
822 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
823LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
824 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000825LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
826 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000827LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
828 LLVMValueRef *Args, unsigned NumArgs,
829 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
830 const char *Name);
831LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
832LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
833
Gordon Henriksen097102c2008-01-01 05:50:53 +0000834/* Add a case to the switch instruction */
835void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
836 LLVMBasicBlockRef Dest);
837
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000838/* Add a destination to the indirectbr instruction */
839void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
840
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000841/* Arithmetic */
842LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
843 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000844LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
845 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000846LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
847 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000848LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
849 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000850LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
851 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000852LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
853 const char *Name);
854LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
855 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000856LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
857 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000858LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
859 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000860LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
861 const char *Name);
862LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
863 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000864LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
865 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000866LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
867 const char *Name);
868LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
869 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000870LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
871 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000872LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
873 const char *Name);
874LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
875 const char *Name);
876LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
877 const char *Name);
878LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
879 const char *Name);
880LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
881 const char *Name);
882LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
883 const char *Name);
884LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
885 const char *Name);
886LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
887 const char *Name);
888LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
889 const char *Name);
890LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
891 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000892LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
893 LLVMValueRef LHS, LLVMValueRef RHS,
894 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000895LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000896LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
897 const char *Name);
898LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
899 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000900LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000901LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
902
903/* Memory */
904LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
905LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
906 LLVMValueRef Val, const char *Name);
907LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
908LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
909 LLVMValueRef Val, const char *Name);
910LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
911LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
912 const char *Name);
913LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
914LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
915 LLVMValueRef *Indices, unsigned NumIndices,
916 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000917LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
918 LLVMValueRef *Indices, unsigned NumIndices,
919 const char *Name);
920LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
921 unsigned Idx, const char *Name);
922LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
923 const char *Name);
924LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
925 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000926
927/* Casts */
928LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
929 LLVMTypeRef DestTy, const char *Name);
930LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
931 LLVMTypeRef DestTy, const char *Name);
932LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
933 LLVMTypeRef DestTy, const char *Name);
934LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
935 LLVMTypeRef DestTy, const char *Name);
936LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
937 LLVMTypeRef DestTy, const char *Name);
938LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
939 LLVMTypeRef DestTy, const char *Name);
940LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
941 LLVMTypeRef DestTy, const char *Name);
942LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
943 LLVMTypeRef DestTy, const char *Name);
944LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
945 LLVMTypeRef DestTy, const char *Name);
946LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
947 LLVMTypeRef DestTy, const char *Name);
948LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
949 LLVMTypeRef DestTy, const char *Name);
950LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
951 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000952LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
953 LLVMTypeRef DestTy, const char *Name);
954LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
955 LLVMTypeRef DestTy, const char *Name);
956LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
957 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000958LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
959 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000960LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
961 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000962LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000963 LLVMTypeRef DestTy, const char *Name);
964LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
965 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000966
967/* Comparisons */
968LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
969 LLVMValueRef LHS, LLVMValueRef RHS,
970 const char *Name);
971LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
972 LLVMValueRef LHS, LLVMValueRef RHS,
973 const char *Name);
974
975/* Miscellaneous instructions */
976LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
977LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
978 LLVMValueRef *Args, unsigned NumArgs,
979 const char *Name);
980LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
981 LLVMValueRef Then, LLVMValueRef Else,
982 const char *Name);
983LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
984 const char *Name);
985LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
986 LLVMValueRef Index, const char *Name);
987LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
988 LLVMValueRef EltVal, LLVMValueRef Index,
989 const char *Name);
990LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
991 LLVMValueRef V2, LLVMValueRef Mask,
992 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000993LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
994 unsigned Index, const char *Name);
995LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
996 LLVMValueRef EltVal, unsigned Index,
997 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000998
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000999LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
1000 const char *Name);
1001LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
1002 const char *Name);
1003LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
1004 LLVMValueRef RHS, const char *Name);
1005
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001006
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001007/*===-- Module providers --------------------------------------------------===*/
1008
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001009/* Changes the type of M so it can be passed to FunctionPassManagers and the
1010 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001011 */
1012LLVMModuleProviderRef
1013LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1014
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001015/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001016 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001017void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001018
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001019
1020/*===-- Memory buffers ----------------------------------------------------===*/
1021
Chris Lattner25963c62010-01-09 22:27:07 +00001022LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1023 LLVMMemoryBufferRef *OutMemBuf,
1024 char **OutMessage);
1025LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1026 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001027void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1028
Owen Anderson4698c5d2010-10-07 17:55:47 +00001029/*===-- Pass Registry -----------------------------------------------------===*/
1030
1031/** Return the global pass registry, for use with initialization functions.
1032 See llvm::PassRegistry::getPassRegistry. */
1033LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001034
1035/*===-- Pass Managers -----------------------------------------------------===*/
1036
1037/** Constructs a new whole-module pass pipeline. This type of pipeline is
1038 suitable for link-time optimization and whole-module transformations.
1039 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001040LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001041
1042/** Constructs a new function-by-function pass pipeline over the module
1043 provider. It does not take ownership of the module provider. This type of
1044 pipeline is suitable for code generation and JIT compilation tasks.
1045 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001046LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1047
1048/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001049LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1050
1051/** Initializes, executes on the provided module, and finalizes all of the
1052 passes scheduled in the pass manager. Returns 1 if any of the passes
1053 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001054LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001055
1056/** Initializes all of the function passes scheduled in the function pass
1057 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1058 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001059LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001060
1061/** Executes all of the function passes scheduled in the function pass manager
1062 on the provided function. Returns 1 if any of the passes modified the
1063 function, false otherwise.
1064 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001065LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001066
1067/** Finalizes all of the function passes scheduled in in the function pass
1068 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1069 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001070LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001071
1072/** Frees the memory of a pass pipeline. For function pipelines, does not free
1073 the module provider.
1074 See llvm::PassManagerBase::~PassManagerBase. */
1075void LLVMDisposePassManager(LLVMPassManagerRef PM);
1076
1077
Gordon Henriksen76a03742007-09-18 03:18:57 +00001078#ifdef __cplusplus
1079}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001080
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001081namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001082 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001083 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001084
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001085 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1086 inline ty *unwrap(ref P) { \
1087 return reinterpret_cast<ty*>(P); \
1088 } \
1089 \
1090 inline ref wrap(const ty *P) { \
1091 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1092 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001093
Gordon Henriksen878114b2008-03-16 04:20:44 +00001094 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1095 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1096 \
1097 template<typename T> \
1098 inline T *unwrap(ref P) { \
1099 return cast<T>(unwrap(P)); \
1100 }
1101
1102 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1103 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1104 \
1105 template<typename T> \
1106 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001107 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001108 assert(Q && "Invalid cast!"); \
1109 return Q; \
1110 }
1111
1112 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1113 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001114 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1115 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001116 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001117 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001118 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001119 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001120 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001121 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Owen Anderson4698c5d2010-10-07 17:55:47 +00001122 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001123 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1124 * Module.
1125 */
1126 inline Module *unwrap(LLVMModuleProviderRef MP) {
1127 return reinterpret_cast<Module*>(MP);
1128 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001129
Gordon Henriksen878114b2008-03-16 04:20:44 +00001130 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1131 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001132 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001133
1134 /* Specialized opaque context conversions.
1135 */
1136 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1137 return reinterpret_cast<LLVMContext**>(Tys);
1138 }
1139
1140 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1141 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1142 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001143
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001144 /* Specialized opaque type conversions.
1145 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001146 inline Type **unwrap(LLVMTypeRef* Tys) {
1147 return reinterpret_cast<Type**>(Tys);
1148 }
1149
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001150 inline LLVMTypeRef *wrap(const Type **Tys) {
1151 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1152 }
1153
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001154 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001155 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001156 inline Value **unwrap(LLVMValueRef *Vals) {
1157 return reinterpret_cast<Value**>(Vals);
1158 }
1159
1160 template<typename T>
1161 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1162 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001163 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001164 cast<T>(*I);
1165 #endif
1166 return reinterpret_cast<T**>(Vals);
1167 }
1168
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001169 inline LLVMValueRef *wrap(const Value **Vals) {
1170 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1171 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001172}
1173
1174#endif /* !defined(__cplusplus) */
1175
1176#endif /* !defined(LLVM_C_CORE_H) */