blob: 148bc723419477f9de2d8701fec74bc9bdcbf9c1 [file] [log] [blame]
Gordon Henriksen76a03742007-09-18 03:18:57 +00001/*===-- llvm-c/Core.h - Core Library C Interface ------------------*- C -*-===*\
2|* *|
3|* The LLVM Compiler Infrastructure *|
4|* *|
Chris Lattnere9cc7422007-12-29 19:59:42 +00005|* This file is distributed under the University of Illinois Open Source *|
6|* License. See LICENSE.TXT for details. *|
Gordon Henriksen76a03742007-09-18 03:18:57 +00007|* *|
8|*===----------------------------------------------------------------------===*|
9|* *|
10|* This header declares the C interface to libLLVMCore.a, which implements *|
11|* the LLVM intermediate representation. *|
12|* *|
13|* LLVM uses a polymorphic type hierarchy which C cannot represent, therefore *|
14|* parameters must be passed as base types. Despite the declared types, most *|
15|* of the functions provided operate only on branches of the type hierarchy. *|
16|* The declared parameter names are descriptive and specify which type is *|
17|* required. Additionally, each type hierarchy is documented along with the *|
18|* functions that operate upon it. For more detail, refer to LLVM's C++ code. *|
19|* If in doubt, refer to Core.cpp, which performs paramter downcasts in the *|
20|* form unwrap<RequiredType>(Param). *|
21|* *|
22|* Many exotic languages can interoperate with C code but have a harder time *|
23|* with C++ due to name mangling. So in addition to C, this interface enables *|
24|* tools written in such languages. *|
25|* *|
Gordon Henriksen7330acd2007-10-05 23:59:36 +000026|* When included into a C++ source file, also declares 'wrap' and 'unwrap' *|
27|* helpers to perform opaque reference<-->pointer conversions. These helpers *|
28|* are shorter and more tightly typed than writing the casts by hand when *|
29|* authoring bindings. In assert builds, they will do runtime type checking. *|
30|* *|
Gordon Henriksen76a03742007-09-18 03:18:57 +000031\*===----------------------------------------------------------------------===*/
32
33#ifndef LLVM_C_CORE_H
34#define LLVM_C_CORE_H
35
Chandler Carruth56869f22009-10-26 01:35:46 +000036#include "llvm/System/DataTypes.h"
Erick Tryzelaardd991352009-08-16 23:36:46 +000037
Gordon Henriksen76a03742007-09-18 03:18:57 +000038#ifdef __cplusplus
Gordon Henriksen7330acd2007-10-05 23:59:36 +000039
40/* Need these includes to support the LLVM 'cast' template for the C++ 'wrap'
41 and 'unwrap' conversion functions. */
42#include "llvm/Module.h"
Duncan Sandsa07136e2008-04-13 06:22:09 +000043#include "llvm/Support/IRBuilder.h"
Gordon Henriksen7330acd2007-10-05 23:59:36 +000044
Gordon Henriksen76a03742007-09-18 03:18:57 +000045extern "C" {
46#endif
47
48
Chris Lattner25963c62010-01-09 22:27:07 +000049typedef int LLVMBool;
50
Gordon Henriksen76a03742007-09-18 03:18:57 +000051/* Opaque types. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000052
53/**
Owen Anderson6773d382009-07-01 16:58:40 +000054 * The top-level container for all LLVM global data. See the LLVMContext class.
55 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +000056typedef struct LLVMOpaqueContext *LLVMContextRef;
Owen Anderson6773d382009-07-01 16:58:40 +000057
58/**
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000059 * The top-level container for all other LLVM Intermediate Representation (IR)
60 * objects. See the llvm::Module class.
61 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000062typedef struct LLVMOpaqueModule *LLVMModuleRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000063
64/**
Gordon Henriksena49d4352008-03-07 19:13:06 +000065 * Each value in the LLVM IR has a type, an LLVMTypeRef. See the llvm::Type
66 * class.
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000067 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000068typedef struct LLVMOpaqueType *LLVMTypeRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000069
70/**
Gordon Henriksena49d4352008-03-07 19:13:06 +000071 * When building recursive types using LLVMRefineType, LLVMTypeRef values may
72 * become invalid; use LLVMTypeHandleRef to resolve this problem. See the
73 * llvm::AbstractTypeHolder class.
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000074 */
Gordon Henriksenffb48762007-10-07 00:13:35 +000075typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000076
Gordon Henriksen76a03742007-09-18 03:18:57 +000077typedef struct LLVMOpaqueValue *LLVMValueRef;
Gordon Henriksenc23b66c2007-09-26 20:56:12 +000078typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
79typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000080
Jeffrey Yasskin091217b2010-01-27 20:34:15 +000081/* Interface used to provide a module to JIT or interpreter. This is now just a
82 * synonym for llvm::Module, but we have to keep using the different type to
83 * keep binary compatibility.
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000084 */
Gordon Henriksen0a68fe22007-12-12 01:04:30 +000085typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
Gordon Henriksen76a03742007-09-18 03:18:57 +000086
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000087/* Used to provide a module to JIT or interpreter.
88 * See the llvm::MemoryBuffer class.
89 */
90typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
91
Gordon Henriksen878114b2008-03-16 04:20:44 +000092/** See the llvm::PassManagerBase class. */
93typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
94
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +000095/** Used to get the users and usees of a Value. See the llvm::Use class. */
96typedef struct LLVMOpaqueUse *LLVMUseRef;
Chris Lattner40cf28d2009-10-12 04:01:02 +000097
Gordon Henriksen76a03742007-09-18 03:18:57 +000098typedef enum {
Devang Patel4c758ea2008-09-25 21:00:45 +000099 LLVMZExtAttribute = 1<<0,
100 LLVMSExtAttribute = 1<<1,
101 LLVMNoReturnAttribute = 1<<2,
102 LLVMInRegAttribute = 1<<3,
103 LLVMStructRetAttribute = 1<<4,
104 LLVMNoUnwindAttribute = 1<<5,
105 LLVMNoAliasAttribute = 1<<6,
106 LLVMByValAttribute = 1<<7,
107 LLVMNestAttribute = 1<<8,
108 LLVMReadNoneAttribute = 1<<9,
Anton Korobeynikovc8ce7b082009-07-17 18:07:26 +0000109 LLVMReadOnlyAttribute = 1<<10,
Anton Korobeynikov9750be92009-07-17 18:57:16 +0000110 LLVMNoInlineAttribute = 1<<11,
111 LLVMAlwaysInlineAttribute = 1<<12,
112 LLVMOptimizeForSizeAttribute = 1<<13,
113 LLVMStackProtectAttribute = 1<<14,
114 LLVMStackProtectReqAttribute = 1<<15,
Erick Tryzelaar8f69fea2010-03-03 23:51:25 +0000115 LLVMAlignment = 31<<16,
Anton Korobeynikov9750be92009-07-17 18:57:16 +0000116 LLVMNoCaptureAttribute = 1<<21,
117 LLVMNoRedZoneAttribute = 1<<22,
118 LLVMNoImplicitFloatAttribute = 1<<23,
Jakob Stoklund Olesen74bb06c2010-02-06 01:16:28 +0000119 LLVMNakedAttribute = 1<<24,
Erick Tryzelaar8f69fea2010-03-03 23:51:25 +0000120 LLVMInlineHintAttribute = 1<<25,
121 LLVMStackAlignment = 7<<26
Devang Patel4c758ea2008-09-25 21:00:45 +0000122} LLVMAttribute;
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000123
124typedef enum {
Bill Wendlingda52cec2010-02-15 20:53:17 +0000125 /* Terminator Instructions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000126 LLVMRet = 1,
127 LLVMBr = 2,
128 LLVMSwitch = 3,
Bill Wendling07d6d762010-02-15 20:50:51 +0000129 LLVMIndirectBr = 4,
130 LLVMInvoke = 5,
131 LLVMUnwind = 6,
132 LLVMUnreachable = 7,
133
Bill Wendlingda52cec2010-02-15 20:53:17 +0000134 /* Standard Binary Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000135 LLVMAdd = 8,
136 LLVMFAdd = 9,
137 LLVMSub = 10,
138 LLVMFSub = 11,
139 LLVMMul = 12,
140 LLVMFMul = 13,
141 LLVMUDiv = 14,
142 LLVMSDiv = 15,
143 LLVMFDiv = 16,
144 LLVMURem = 17,
145 LLVMSRem = 18,
146 LLVMFRem = 19,
147
Bill Wendlingda52cec2010-02-15 20:53:17 +0000148 /* Logical Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000149 LLVMShl = 20,
150 LLVMLShr = 21,
151 LLVMAShr = 22,
152 LLVMAnd = 23,
153 LLVMOr = 24,
154 LLVMXor = 25,
155
Bill Wendlingda52cec2010-02-15 20:53:17 +0000156 /* Memory Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000157 LLVMAlloca = 26,
158 LLVMLoad = 27,
159 LLVMStore = 28,
160 LLVMGetElementPtr = 29,
161
Bill Wendlingda52cec2010-02-15 20:53:17 +0000162 /* Cast Operators */
Erick Tryzelaar5bf1a322010-02-16 03:45:23 +0000163 LLVMTrunc = 30,
Bill Wendling07d6d762010-02-15 20:50:51 +0000164 LLVMZExt = 31,
165 LLVMSExt = 32,
166 LLVMFPToUI = 33,
167 LLVMFPToSI = 34,
168 LLVMUIToFP = 35,
169 LLVMSIToFP = 36,
170 LLVMFPTrunc = 37,
171 LLVMFPExt = 38,
172 LLVMPtrToInt = 39,
173 LLVMIntToPtr = 40,
174 LLVMBitCast = 41,
175
Bill Wendlingda52cec2010-02-15 20:53:17 +0000176 /* Other Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000177 LLVMICmp = 42,
178 LLVMFCmp = 43,
179 LLVMPHI = 44,
180 LLVMCall = 45,
181 LLVMSelect = 46,
Bill Wendlingda52cec2010-02-15 20:53:17 +0000182 /* UserOp1 */
183 /* UserOp2 */
Bill Wendling07d6d762010-02-15 20:50:51 +0000184 LLVMVAArg = 49,
185 LLVMExtractElement = 50,
186 LLVMInsertElement = 51,
187 LLVMShuffleVector = 52,
188 LLVMExtractValue = 53,
189 LLVMInsertValue = 54
Chris Lattner40cf28d2009-10-12 04:01:02 +0000190} LLVMOpcode;
191
192typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000193 LLVMVoidTypeKind, /**< type with no size */
194 LLVMFloatTypeKind, /**< 32 bit floating point type */
195 LLVMDoubleTypeKind, /**< 64 bit floating point type */
196 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
197 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
198 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
199 LLVMLabelTypeKind, /**< Labels */
200 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
201 LLVMFunctionTypeKind, /**< Functions */
202 LLVMStructTypeKind, /**< Structures */
203 LLVMArrayTypeKind, /**< Arrays */
204 LLVMPointerTypeKind, /**< Pointers */
205 LLVMOpaqueTypeKind, /**< Opaque: type with unknown structure */
Chris Lattnerdac44ec2009-07-15 22:00:31 +0000206 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
Dale Johannesenbaa5d042010-09-10 20:55:01 +0000207 LLVMMetadataTypeKind, /**< Metadata */
208 LLVMX86_MMXTypeKind /**< X86 MMX */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000209} LLVMTypeKind;
210
211typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000212 LLVMExternalLinkage, /**< Externally visible function */
Chris Lattner2dba0f02009-04-13 06:25:37 +0000213 LLVMAvailableExternallyLinkage,
Duncan Sands12da8ce2009-03-07 15:45:40 +0000214 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
215 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
216 equivalent. */
217 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
218 LLVMWeakODRLinkage, /**< Same, but only replaced by something
219 equivalent. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000220 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
221 LLVMInternalLinkage, /**< Rename collisions when linking (static
222 functions) */
Duncan Sands12da8ce2009-03-07 15:45:40 +0000223 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000224 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
225 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
Duncan Sandse2881052009-03-11 08:08:06 +0000226 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000227 LLVMGhostLinkage, /**< Obsolete */
Bill Wendling002b1672009-07-20 18:22:52 +0000228 LLVMCommonLinkage, /**< Tentative definitions */
Bill Wendling03bcd6e2010-07-01 21:55:59 +0000229 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
Bill Wendling578ee402010-08-20 22:05:50 +0000230 LLVMLinkerPrivateWeakLinkage, /**< Like LinkerPrivate, but is weak. */
231 LLVMLinkerPrivateWeakDefAutoLinkage /**< Like LinkerPrivateWeak, but possibly
232 hidden. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000233} LLVMLinkage;
234
235typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000236 LLVMDefaultVisibility, /**< The GV is visible */
237 LLVMHiddenVisibility, /**< The GV is hidden */
238 LLVMProtectedVisibility /**< The GV is protected */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000239} LLVMVisibility;
240
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000241typedef enum {
242 LLVMCCallConv = 0,
243 LLVMFastCallConv = 8,
244 LLVMColdCallConv = 9,
245 LLVMX86StdcallCallConv = 64,
246 LLVMX86FastcallCallConv = 65
247} LLVMCallConv;
248
249typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000250 LLVMIntEQ = 32, /**< equal */
251 LLVMIntNE, /**< not equal */
252 LLVMIntUGT, /**< unsigned greater than */
253 LLVMIntUGE, /**< unsigned greater or equal */
254 LLVMIntULT, /**< unsigned less than */
255 LLVMIntULE, /**< unsigned less or equal */
256 LLVMIntSGT, /**< signed greater than */
257 LLVMIntSGE, /**< signed greater or equal */
258 LLVMIntSLT, /**< signed less than */
259 LLVMIntSLE /**< signed less or equal */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000260} LLVMIntPredicate;
261
262typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000263 LLVMRealPredicateFalse, /**< Always false (always folded) */
264 LLVMRealOEQ, /**< True if ordered and equal */
265 LLVMRealOGT, /**< True if ordered and greater than */
266 LLVMRealOGE, /**< True if ordered and greater than or equal */
267 LLVMRealOLT, /**< True if ordered and less than */
268 LLVMRealOLE, /**< True if ordered and less than or equal */
269 LLVMRealONE, /**< True if ordered and operands are unequal */
270 LLVMRealORD, /**< True if ordered (no nans) */
271 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
272 LLVMRealUEQ, /**< True if unordered or equal */
273 LLVMRealUGT, /**< True if unordered or greater than */
274 LLVMRealUGE, /**< True if unordered, greater than, or equal */
275 LLVMRealULT, /**< True if unordered or less than */
276 LLVMRealULE, /**< True if unordered, less than, or equal */
277 LLVMRealUNE, /**< True if unordered or not equal */
278 LLVMRealPredicateTrue /**< Always true (always folded) */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000279} LLVMRealPredicate;
280
Gordon Henriksen76a03742007-09-18 03:18:57 +0000281
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000282/*===-- Error handling ----------------------------------------------------===*/
283
284void LLVMDisposeMessage(char *Message);
285
286
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000287/*===-- Contexts ----------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000288
Owen Anderson6773d382009-07-01 16:58:40 +0000289/* Create and destroy contexts. */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000290LLVMContextRef LLVMContextCreate(void);
291LLVMContextRef LLVMGetGlobalContext(void);
Owen Anderson6773d382009-07-01 16:58:40 +0000292void LLVMContextDispose(LLVMContextRef C);
293
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000294unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
295 unsigned SLen);
296unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
297
298/*===-- Modules -----------------------------------------------------------===*/
299
Gordon Henriksen76a03742007-09-18 03:18:57 +0000300/* Create and destroy modules. */
Gordon Henriksena49d4352008-03-07 19:13:06 +0000301/** See llvm::Module::Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000302LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Owen Anderson31d44e42009-07-02 07:17:57 +0000303LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
304 LLVMContextRef C);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000305
306/** See llvm::Module::~Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000307void LLVMDisposeModule(LLVMModuleRef M);
308
Gordon Henriksena49d4352008-03-07 19:13:06 +0000309/** Data layout. See Module::getDataLayout. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000310const char *LLVMGetDataLayout(LLVMModuleRef M);
311void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
312
Gordon Henriksena49d4352008-03-07 19:13:06 +0000313/** Target triple. See Module::getTargetTriple. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000314const char *LLVMGetTarget(LLVMModuleRef M);
315void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
316
Gordon Henriksena49d4352008-03-07 19:13:06 +0000317/** See Module::addTypeName. */
Chris Lattner25963c62010-01-09 22:27:07 +0000318LLVMBool LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000319void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
Chris Lattner7f318242009-07-06 17:29:59 +0000320LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000321
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000322/** See Module::dump. */
323void LLVMDumpModule(LLVMModuleRef M);
324
Chris Lattner26941452010-04-10 17:52:58 +0000325/** See Module::setModuleInlineAsm. */
326void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000327
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000328/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000329
330/* LLVM types conform to the following hierarchy:
331 *
332 * types:
333 * integer type
334 * real type
335 * function type
336 * sequence types:
337 * array type
338 * pointer type
339 * vector type
340 * void type
341 * label type
342 * opaque type
343 */
344
Gordon Henriksena49d4352008-03-07 19:13:06 +0000345/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000346LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000347
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000348/** See llvm::LLVMType::getContext. */
349LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
350
Gordon Henriksen76a03742007-09-18 03:18:57 +0000351/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000352LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
353LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
354LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
355LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
356LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
357LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
358
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000359LLVMTypeRef LLVMInt1Type(void);
360LLVMTypeRef LLVMInt8Type(void);
361LLVMTypeRef LLVMInt16Type(void);
362LLVMTypeRef LLVMInt32Type(void);
363LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000364LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000365unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000366
367/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000368LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
369LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
370LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
371LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
372LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
373
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000374LLVMTypeRef LLVMFloatType(void);
375LLVMTypeRef LLVMDoubleType(void);
376LLVMTypeRef LLVMX86FP80Type(void);
377LLVMTypeRef LLVMFP128Type(void);
378LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000379
380/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000381LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
382 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000383 LLVMBool IsVarArg);
384LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000385LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
386unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
387void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000388
389/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000390LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000391 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000392LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000393 LLVMBool Packed);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000394unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000395void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000396LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000397
398/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000399LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000400LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000401LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000402
403LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
404unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000405unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000406unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
407
408/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000409LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
410LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
411LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000412LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000413
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000414LLVMTypeRef LLVMVoidType(void);
415LLVMTypeRef LLVMLabelType(void);
416LLVMTypeRef LLVMOpaqueType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000417LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000418
Gordon Henriksenffb48762007-10-07 00:13:35 +0000419/* Operations on type handles */
420LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
421void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
422LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
423void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
424
Gordon Henriksen76a03742007-09-18 03:18:57 +0000425
426/*===-- Values ------------------------------------------------------------===*/
427
428/* The bulk of LLVM's object model consists of values, which comprise a very
429 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000430 */
431
Gordon Henriksen29e38942008-12-19 18:39:45 +0000432#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
433 macro(Argument) \
434 macro(BasicBlock) \
435 macro(InlineAsm) \
436 macro(User) \
437 macro(Constant) \
438 macro(ConstantAggregateZero) \
439 macro(ConstantArray) \
440 macro(ConstantExpr) \
441 macro(ConstantFP) \
442 macro(ConstantInt) \
443 macro(ConstantPointerNull) \
444 macro(ConstantStruct) \
445 macro(ConstantVector) \
446 macro(GlobalValue) \
447 macro(Function) \
448 macro(GlobalAlias) \
449 macro(GlobalVariable) \
450 macro(UndefValue) \
451 macro(Instruction) \
452 macro(BinaryOperator) \
453 macro(CallInst) \
454 macro(IntrinsicInst) \
455 macro(DbgInfoIntrinsic) \
456 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000457 macro(EHSelectorInst) \
458 macro(MemIntrinsic) \
459 macro(MemCpyInst) \
460 macro(MemMoveInst) \
461 macro(MemSetInst) \
462 macro(CmpInst) \
463 macro(FCmpInst) \
464 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000465 macro(ExtractElementInst) \
466 macro(GetElementPtrInst) \
467 macro(InsertElementInst) \
468 macro(InsertValueInst) \
469 macro(PHINode) \
470 macro(SelectInst) \
471 macro(ShuffleVectorInst) \
472 macro(StoreInst) \
473 macro(TerminatorInst) \
474 macro(BranchInst) \
475 macro(InvokeInst) \
476 macro(ReturnInst) \
477 macro(SwitchInst) \
478 macro(UnreachableInst) \
479 macro(UnwindInst) \
480 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000481 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000482 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000483 macro(BitCastInst) \
484 macro(FPExtInst) \
485 macro(FPToSIInst) \
486 macro(FPToUIInst) \
487 macro(FPTruncInst) \
488 macro(IntToPtrInst) \
489 macro(PtrToIntInst) \
490 macro(SExtInst) \
491 macro(SIToFPInst) \
492 macro(TruncInst) \
493 macro(UIToFPInst) \
494 macro(ZExtInst) \
495 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000496 macro(LoadInst) \
497 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000498
Gordon Henriksen76a03742007-09-18 03:18:57 +0000499/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000500LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000501const char *LLVMGetValueName(LLVMValueRef Val);
502void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000503void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000504void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000505int LLVMHasMetadata(LLVMValueRef Val);
506LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
507void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000508
Gordon Henriksen29e38942008-12-19 18:39:45 +0000509/* Conversion functions. Return the input value if it is an instance of the
510 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
511#define LLVM_DECLARE_VALUE_CAST(name) \
512 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
513LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
514
Chris Lattner40cf28d2009-10-12 04:01:02 +0000515/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000516LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
517LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
518LLVMValueRef LLVMGetUser(LLVMUseRef U);
519LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000520
521/* Operations on Users */
522LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Erick Tryzelaarb4d48702010-08-20 14:51:22 +0000523void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
524int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000525
Gordon Henriksen76a03742007-09-18 03:18:57 +0000526/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000527LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
528LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000529LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000530LLVMBool LLVMIsConstant(LLVMValueRef Val);
531LLVMBool LLVMIsNull(LLVMValueRef Val);
532LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000533LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000534
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000535/* Operations on metadata */
536LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
537 unsigned SLen);
538LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
539LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
540 unsigned Count);
541LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
542
Gordon Henriksen76a03742007-09-18 03:18:57 +0000543/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000544LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000545 LLVMBool SignExtend);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000546LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
547 uint8_t Radix);
548LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
549 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000550LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000551LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000552LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
553 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000554unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
555long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000556
Gordon Henriksen76a03742007-09-18 03:18:57 +0000557
558/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000559LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000560 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000561LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
562 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000563 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000564
Gordon Henriksen1046c732007-10-06 15:11:06 +0000565LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000566 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000567LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000568 LLVMValueRef *ConstantVals, unsigned Length);
569LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000570 LLVMBool Packed);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000571LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000572
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000573/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000574LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000575LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000576LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
577LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000578LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
579LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000580LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000581LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
582LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000583LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000584LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000585LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000586LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000587LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
588LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000589LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000590LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000591LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
592LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000593LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000594LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
595LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000596LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000597LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
598LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
599LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
600LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
601LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
602LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
604LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
605 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
606LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
607 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
609LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
611LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
612 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000613LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
614 LLVMValueRef *ConstantIndices,
615 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000616LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
617LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
618LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
619LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
620LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
621LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
622LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
623LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
624LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
625LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
626LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
627LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000628LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
629 LLVMTypeRef ToType);
630LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
631 LLVMTypeRef ToType);
632LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
633 LLVMTypeRef ToType);
634LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
635 LLVMTypeRef ToType);
636LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000637 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000638LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000639LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
640 LLVMValueRef ConstantIfTrue,
641 LLVMValueRef ConstantIfFalse);
642LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
643 LLVMValueRef IndexConstant);
644LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
645 LLVMValueRef ElementValueConstant,
646 LLVMValueRef IndexConstant);
647LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
648 LLVMValueRef VectorBConstant,
649 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000650LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
651 unsigned NumIdx);
652LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
653 LLVMValueRef ElementValueConstant,
654 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000655LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000656 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000657 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000658LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000659
Gordon Henriksen76a03742007-09-18 03:18:57 +0000660/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000661LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000662LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000663LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
664void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
665const char *LLVMGetSection(LLVMValueRef Global);
666void LLVMSetSection(LLVMValueRef Global, const char *Section);
667LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
668void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
669unsigned LLVMGetAlignment(LLVMValueRef Global);
670void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
671
672/* Operations on global variables */
673LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000674LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
675 const char *Name,
676 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000677LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000678LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
679LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
680LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
681LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000682void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000683LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
684void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000685LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
686void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
687LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
688void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000689
Chris Lattner3d1f5522008-12-17 21:39:50 +0000690/* Operations on aliases */
691LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
692 const char *Name);
693
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000694/* Operations on functions */
695LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
696 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000697LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000698LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
699LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
700LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
701LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000702void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000703unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
704unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
705void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000706const char *LLVMGetGC(LLVMValueRef Fn);
707void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000708void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000709LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000710void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000711
Gordon Henriksen265f7802008-03-19 01:11:35 +0000712/* Operations on parameters */
713unsigned LLVMCountParams(LLVMValueRef Fn);
714void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
715LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
716LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000717LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
718LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
719LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
720LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000721void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
722void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000723LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000724void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000725
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000726/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000727LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000728LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000729LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000730LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000731unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
732void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000733LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
734LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
735LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
736LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000737LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000738
739LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
740 LLVMValueRef Fn,
741 const char *Name);
742LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
743 LLVMBasicBlockRef BB,
744 const char *Name);
745
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000746LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
747LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
748 const char *Name);
749void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
750
Duncan Sandsb1d61aa2010-07-19 15:31:07 +0000751void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
752void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
753
Gordon Henriksen265f7802008-03-19 01:11:35 +0000754/* Operations on instructions */
755LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000756LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
757LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
758LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
759LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000760
Gordon Henriksen1158c532007-12-29 20:45:00 +0000761/* Operations on call sites */
762void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
763unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000764void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
765void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
766 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000767void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
768 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000769
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000770/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000771LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
772void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000773
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000774/* Operations on phi nodes */
775void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
776 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
777unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
778LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
779LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000780
781/*===-- Instruction builders ----------------------------------------------===*/
782
783/* An instruction builder represents a point within a basic block, and is the
784 * exclusive means of building instructions using the C interface.
785 */
786
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000787LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000788LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000789void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
790 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000791void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
792void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000793LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000794void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
795void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000796void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
797 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000798void LLVMDisposeBuilder(LLVMBuilderRef Builder);
799
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000800/* Metadata */
801void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
802LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
803void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
804
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000805/* Terminators */
806LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
807LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000808LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000809 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000810LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
811LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
812 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
813LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
814 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000815LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
816 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000817LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
818 LLVMValueRef *Args, unsigned NumArgs,
819 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
820 const char *Name);
821LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
822LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
823
Gordon Henriksen097102c2008-01-01 05:50:53 +0000824/* Add a case to the switch instruction */
825void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
826 LLVMBasicBlockRef Dest);
827
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000828/* Add a destination to the indirectbr instruction */
829void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
830
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000831/* Arithmetic */
832LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
833 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000834LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
835 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000836LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
837 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000838LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
839 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000840LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
841 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000842LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
843 const char *Name);
844LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
845 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000846LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
847 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000848LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
849 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000850LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
851 const char *Name);
852LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
853 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000854LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
855 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000856LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
857 const char *Name);
858LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
859 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000860LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
861 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000862LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
863 const char *Name);
864LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
865 const char *Name);
866LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
867 const char *Name);
868LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
869 const char *Name);
870LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
871 const char *Name);
872LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
873 const char *Name);
874LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
875 const char *Name);
876LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
877 const char *Name);
878LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
879 const char *Name);
880LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
881 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000882LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
883 LLVMValueRef LHS, LLVMValueRef RHS,
884 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000885LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000886LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
887 const char *Name);
888LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
889 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000890LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000891LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
892
893/* Memory */
894LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
895LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
896 LLVMValueRef Val, const char *Name);
897LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
898LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
899 LLVMValueRef Val, const char *Name);
900LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
901LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
902 const char *Name);
903LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
904LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
905 LLVMValueRef *Indices, unsigned NumIndices,
906 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000907LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
908 LLVMValueRef *Indices, unsigned NumIndices,
909 const char *Name);
910LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
911 unsigned Idx, const char *Name);
912LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
913 const char *Name);
914LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
915 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000916
917/* Casts */
918LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
919 LLVMTypeRef DestTy, const char *Name);
920LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
921 LLVMTypeRef DestTy, const char *Name);
922LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
923 LLVMTypeRef DestTy, const char *Name);
924LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
925 LLVMTypeRef DestTy, const char *Name);
926LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
927 LLVMTypeRef DestTy, const char *Name);
928LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
929 LLVMTypeRef DestTy, const char *Name);
930LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
931 LLVMTypeRef DestTy, const char *Name);
932LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
933 LLVMTypeRef DestTy, const char *Name);
934LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
935 LLVMTypeRef DestTy, const char *Name);
936LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
937 LLVMTypeRef DestTy, const char *Name);
938LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
939 LLVMTypeRef DestTy, const char *Name);
940LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
941 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000942LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
943 LLVMTypeRef DestTy, const char *Name);
944LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
945 LLVMTypeRef DestTy, const char *Name);
946LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
947 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000948LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
949 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000950LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
951 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000952LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000953 LLVMTypeRef DestTy, const char *Name);
954LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
955 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000956
957/* Comparisons */
958LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
959 LLVMValueRef LHS, LLVMValueRef RHS,
960 const char *Name);
961LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
962 LLVMValueRef LHS, LLVMValueRef RHS,
963 const char *Name);
964
965/* Miscellaneous instructions */
966LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
967LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
968 LLVMValueRef *Args, unsigned NumArgs,
969 const char *Name);
970LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
971 LLVMValueRef Then, LLVMValueRef Else,
972 const char *Name);
973LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
974 const char *Name);
975LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
976 LLVMValueRef Index, const char *Name);
977LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
978 LLVMValueRef EltVal, LLVMValueRef Index,
979 const char *Name);
980LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
981 LLVMValueRef V2, LLVMValueRef Mask,
982 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000983LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
984 unsigned Index, const char *Name);
985LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
986 LLVMValueRef EltVal, unsigned Index,
987 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000988
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000989LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
990 const char *Name);
991LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
992 const char *Name);
993LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
994 LLVMValueRef RHS, const char *Name);
995
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000996
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000997/*===-- Module providers --------------------------------------------------===*/
998
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000999/* Changes the type of M so it can be passed to FunctionPassManagers and the
1000 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001001 */
1002LLVMModuleProviderRef
1003LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1004
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001005/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001006 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001007void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001008
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001009
1010/*===-- Memory buffers ----------------------------------------------------===*/
1011
Chris Lattner25963c62010-01-09 22:27:07 +00001012LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1013 LLVMMemoryBufferRef *OutMemBuf,
1014 char **OutMessage);
1015LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1016 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001017void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1018
Gordon Henriksen878114b2008-03-16 04:20:44 +00001019
1020/*===-- Pass Managers -----------------------------------------------------===*/
1021
1022/** Constructs a new whole-module pass pipeline. This type of pipeline is
1023 suitable for link-time optimization and whole-module transformations.
1024 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001025LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001026
1027/** Constructs a new function-by-function pass pipeline over the module
1028 provider. It does not take ownership of the module provider. This type of
1029 pipeline is suitable for code generation and JIT compilation tasks.
1030 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001031LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1032
1033/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001034LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1035
1036/** Initializes, executes on the provided module, and finalizes all of the
1037 passes scheduled in the pass manager. Returns 1 if any of the passes
1038 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001039LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001040
1041/** Initializes all of the function passes scheduled in the function pass
1042 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1043 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001044LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001045
1046/** Executes all of the function passes scheduled in the function pass manager
1047 on the provided function. Returns 1 if any of the passes modified the
1048 function, false otherwise.
1049 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001050LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001051
1052/** Finalizes all of the function passes scheduled in in the function pass
1053 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1054 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001055LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001056
1057/** Frees the memory of a pass pipeline. For function pipelines, does not free
1058 the module provider.
1059 See llvm::PassManagerBase::~PassManagerBase. */
1060void LLVMDisposePassManager(LLVMPassManagerRef PM);
1061
1062
Gordon Henriksen76a03742007-09-18 03:18:57 +00001063#ifdef __cplusplus
1064}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001065
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001066namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001067 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001068 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001069
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001070 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1071 inline ty *unwrap(ref P) { \
1072 return reinterpret_cast<ty*>(P); \
1073 } \
1074 \
1075 inline ref wrap(const ty *P) { \
1076 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1077 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001078
Gordon Henriksen878114b2008-03-16 04:20:44 +00001079 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1080 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1081 \
1082 template<typename T> \
1083 inline T *unwrap(ref P) { \
1084 return cast<T>(unwrap(P)); \
1085 }
1086
1087 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1088 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1089 \
1090 template<typename T> \
1091 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001092 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001093 assert(Q && "Invalid cast!"); \
1094 return Q; \
1095 }
1096
1097 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1098 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001099 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1100 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001101 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001102 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001103 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001104 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001105 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001106 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001107 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1108 * Module.
1109 */
1110 inline Module *unwrap(LLVMModuleProviderRef MP) {
1111 return reinterpret_cast<Module*>(MP);
1112 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001113
Gordon Henriksen878114b2008-03-16 04:20:44 +00001114 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1115 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001116 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001117
1118 /* Specialized opaque context conversions.
1119 */
1120 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1121 return reinterpret_cast<LLVMContext**>(Tys);
1122 }
1123
1124 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1125 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1126 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001127
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001128 /* Specialized opaque type conversions.
1129 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001130 inline Type **unwrap(LLVMTypeRef* Tys) {
1131 return reinterpret_cast<Type**>(Tys);
1132 }
1133
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001134 inline LLVMTypeRef *wrap(const Type **Tys) {
1135 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1136 }
1137
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001138 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001139 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001140 inline Value **unwrap(LLVMValueRef *Vals) {
1141 return reinterpret_cast<Value**>(Vals);
1142 }
1143
1144 template<typename T>
1145 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1146 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001147 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001148 cast<T>(*I);
1149 #endif
1150 return reinterpret_cast<T**>(Vals);
1151 }
1152
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001153 inline LLVMValueRef *wrap(const Value **Vals) {
1154 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1155 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001156}
1157
1158#endif /* !defined(__cplusplus) */
1159
1160#endif /* !defined(LLVM_C_CORE_H) */