blob: 9ac1c9c54b3ab918ca2fe5985c6126c16b8ecb4c [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);
412
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000413LLVMTypeRef LLVMVoidType(void);
414LLVMTypeRef LLVMLabelType(void);
415LLVMTypeRef LLVMOpaqueType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000416
Gordon Henriksenffb48762007-10-07 00:13:35 +0000417/* Operations on type handles */
418LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
419void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
420LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
421void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
422
Gordon Henriksen76a03742007-09-18 03:18:57 +0000423
424/*===-- Values ------------------------------------------------------------===*/
425
426/* The bulk of LLVM's object model consists of values, which comprise a very
427 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000428 */
429
Gordon Henriksen29e38942008-12-19 18:39:45 +0000430#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
431 macro(Argument) \
432 macro(BasicBlock) \
433 macro(InlineAsm) \
434 macro(User) \
435 macro(Constant) \
436 macro(ConstantAggregateZero) \
437 macro(ConstantArray) \
438 macro(ConstantExpr) \
439 macro(ConstantFP) \
440 macro(ConstantInt) \
441 macro(ConstantPointerNull) \
442 macro(ConstantStruct) \
443 macro(ConstantVector) \
444 macro(GlobalValue) \
445 macro(Function) \
446 macro(GlobalAlias) \
447 macro(GlobalVariable) \
448 macro(UndefValue) \
449 macro(Instruction) \
450 macro(BinaryOperator) \
451 macro(CallInst) \
452 macro(IntrinsicInst) \
453 macro(DbgInfoIntrinsic) \
454 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000455 macro(EHSelectorInst) \
456 macro(MemIntrinsic) \
457 macro(MemCpyInst) \
458 macro(MemMoveInst) \
459 macro(MemSetInst) \
460 macro(CmpInst) \
461 macro(FCmpInst) \
462 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000463 macro(ExtractElementInst) \
464 macro(GetElementPtrInst) \
465 macro(InsertElementInst) \
466 macro(InsertValueInst) \
467 macro(PHINode) \
468 macro(SelectInst) \
469 macro(ShuffleVectorInst) \
470 macro(StoreInst) \
471 macro(TerminatorInst) \
472 macro(BranchInst) \
473 macro(InvokeInst) \
474 macro(ReturnInst) \
475 macro(SwitchInst) \
476 macro(UnreachableInst) \
477 macro(UnwindInst) \
478 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000479 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000480 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000481 macro(BitCastInst) \
482 macro(FPExtInst) \
483 macro(FPToSIInst) \
484 macro(FPToUIInst) \
485 macro(FPTruncInst) \
486 macro(IntToPtrInst) \
487 macro(PtrToIntInst) \
488 macro(SExtInst) \
489 macro(SIToFPInst) \
490 macro(TruncInst) \
491 macro(UIToFPInst) \
492 macro(ZExtInst) \
493 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000494 macro(LoadInst) \
495 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000496
Gordon Henriksen76a03742007-09-18 03:18:57 +0000497/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000498LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000499const char *LLVMGetValueName(LLVMValueRef Val);
500void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000501void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000502void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000503int LLVMHasMetadata(LLVMValueRef Val);
504LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
505void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000506
Gordon Henriksen29e38942008-12-19 18:39:45 +0000507/* Conversion functions. Return the input value if it is an instance of the
508 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
509#define LLVM_DECLARE_VALUE_CAST(name) \
510 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
511LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
512
Chris Lattner40cf28d2009-10-12 04:01:02 +0000513/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000514LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
515LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
516LLVMValueRef LLVMGetUser(LLVMUseRef U);
517LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000518
519/* Operations on Users */
520LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Erick Tryzelaarb4d48702010-08-20 14:51:22 +0000521void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
522int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000523
Gordon Henriksen76a03742007-09-18 03:18:57 +0000524/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000525LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
526LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000527LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000528LLVMBool LLVMIsConstant(LLVMValueRef Val);
529LLVMBool LLVMIsNull(LLVMValueRef Val);
530LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000531LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000532
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000533/* Operations on metadata */
534LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
535 unsigned SLen);
536LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
537LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
538 unsigned Count);
539LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
540
Gordon Henriksen76a03742007-09-18 03:18:57 +0000541/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000542LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000543 LLVMBool SignExtend);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000544LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
545 uint8_t Radix);
546LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
547 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000548LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000549LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000550LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
551 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000552unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
553long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000554
Gordon Henriksen76a03742007-09-18 03:18:57 +0000555
556/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000557LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000558 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000559LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
560 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000561 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000562
Gordon Henriksen1046c732007-10-06 15:11:06 +0000563LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000564 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000565LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000566 LLVMValueRef *ConstantVals, unsigned Length);
567LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000568 LLVMBool Packed);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000569LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000570
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000571/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000572LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000573LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000574LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
575LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000576LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
577LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000578LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000579LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
580LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000581LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000582LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000583LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000584LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000585LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
586LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000587LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000588LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000589LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
590LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000591LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000592LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
593LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000594LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000595LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
596LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
597LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
598LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
599LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
600LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
601LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
602LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
603 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
604LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
605 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
606LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
607LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
609LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
610 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000611LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
612 LLVMValueRef *ConstantIndices,
613 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000614LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
615LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
616LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
617LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
618LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
619LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
620LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
621LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
622LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
623LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
624LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
625LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000626LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
627 LLVMTypeRef ToType);
628LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
629 LLVMTypeRef ToType);
630LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
631 LLVMTypeRef ToType);
632LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
633 LLVMTypeRef ToType);
634LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000635 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000636LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000637LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
638 LLVMValueRef ConstantIfTrue,
639 LLVMValueRef ConstantIfFalse);
640LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
641 LLVMValueRef IndexConstant);
642LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
643 LLVMValueRef ElementValueConstant,
644 LLVMValueRef IndexConstant);
645LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
646 LLVMValueRef VectorBConstant,
647 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000648LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
649 unsigned NumIdx);
650LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
651 LLVMValueRef ElementValueConstant,
652 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000653LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000654 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000655 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000656LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000657
Gordon Henriksen76a03742007-09-18 03:18:57 +0000658/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000659LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000660LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000661LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
662void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
663const char *LLVMGetSection(LLVMValueRef Global);
664void LLVMSetSection(LLVMValueRef Global, const char *Section);
665LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
666void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
667unsigned LLVMGetAlignment(LLVMValueRef Global);
668void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
669
670/* Operations on global variables */
671LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000672LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
673 const char *Name,
674 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000675LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000676LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
677LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
678LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
679LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000680void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000681LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
682void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000683LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
684void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
685LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
686void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000687
Chris Lattner3d1f5522008-12-17 21:39:50 +0000688/* Operations on aliases */
689LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
690 const char *Name);
691
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000692/* Operations on functions */
693LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
694 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000695LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000696LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
697LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
698LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
699LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000700void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000701unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
702unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
703void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000704const char *LLVMGetGC(LLVMValueRef Fn);
705void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000706void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000707LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000708void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000709
Gordon Henriksen265f7802008-03-19 01:11:35 +0000710/* Operations on parameters */
711unsigned LLVMCountParams(LLVMValueRef Fn);
712void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
713LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
714LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000715LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
716LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
717LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
718LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000719void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
720void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000721LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000722void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000723
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000724/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000725LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000726LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000727LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000728LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000729unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
730void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000731LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
732LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
733LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
734LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000735LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000736
737LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
738 LLVMValueRef Fn,
739 const char *Name);
740LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
741 LLVMBasicBlockRef BB,
742 const char *Name);
743
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000744LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
745LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
746 const char *Name);
747void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
748
Duncan Sandsb1d61aa2010-07-19 15:31:07 +0000749void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
750void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
751
Gordon Henriksen265f7802008-03-19 01:11:35 +0000752/* Operations on instructions */
753LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000754LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
755LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
756LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
757LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000758
Gordon Henriksen1158c532007-12-29 20:45:00 +0000759/* Operations on call sites */
760void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
761unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000762void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
763void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
764 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000765void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
766 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000767
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000768/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000769LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
770void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000771
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000772/* Operations on phi nodes */
773void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
774 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
775unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
776LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
777LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000778
779/*===-- Instruction builders ----------------------------------------------===*/
780
781/* An instruction builder represents a point within a basic block, and is the
782 * exclusive means of building instructions using the C interface.
783 */
784
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000785LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000786LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000787void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
788 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000789void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
790void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000791LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000792void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
793void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000794void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
795 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000796void LLVMDisposeBuilder(LLVMBuilderRef Builder);
797
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000798/* Metadata */
799void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
800LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
801void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
802
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000803/* Terminators */
804LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
805LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000806LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000807 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000808LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
809LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
810 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
811LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
812 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000813LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
814 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000815LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
816 LLVMValueRef *Args, unsigned NumArgs,
817 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
818 const char *Name);
819LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
820LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
821
Gordon Henriksen097102c2008-01-01 05:50:53 +0000822/* Add a case to the switch instruction */
823void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
824 LLVMBasicBlockRef Dest);
825
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000826/* Add a destination to the indirectbr instruction */
827void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
828
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000829/* Arithmetic */
830LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
831 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000832LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
833 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000834LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
835 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000836LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
837 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000838LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
839 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000840LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
841 const char *Name);
842LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
843 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000844LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
845 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000846LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
847 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000848LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
849 const char *Name);
850LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
851 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000852LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
853 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000854LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
855 const char *Name);
856LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
857 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000858LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
859 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000860LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
861 const char *Name);
862LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
863 const char *Name);
864LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
865 const char *Name);
866LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
867 const char *Name);
868LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
869 const char *Name);
870LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
871 const char *Name);
872LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
873 const char *Name);
874LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
875 const char *Name);
876LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
877 const char *Name);
878LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
879 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000880LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
881 LLVMValueRef LHS, LLVMValueRef RHS,
882 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000883LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000884LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
885 const char *Name);
886LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
887 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000888LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000889LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
890
891/* Memory */
892LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
893LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
894 LLVMValueRef Val, const char *Name);
895LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
896LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
897 LLVMValueRef Val, const char *Name);
898LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
899LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
900 const char *Name);
901LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
902LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
903 LLVMValueRef *Indices, unsigned NumIndices,
904 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000905LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
906 LLVMValueRef *Indices, unsigned NumIndices,
907 const char *Name);
908LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
909 unsigned Idx, const char *Name);
910LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
911 const char *Name);
912LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
913 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000914
915/* Casts */
916LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
917 LLVMTypeRef DestTy, const char *Name);
918LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
919 LLVMTypeRef DestTy, const char *Name);
920LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
921 LLVMTypeRef DestTy, const char *Name);
922LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
923 LLVMTypeRef DestTy, const char *Name);
924LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
925 LLVMTypeRef DestTy, const char *Name);
926LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
927 LLVMTypeRef DestTy, const char *Name);
928LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
929 LLVMTypeRef DestTy, const char *Name);
930LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
931 LLVMTypeRef DestTy, const char *Name);
932LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
933 LLVMTypeRef DestTy, const char *Name);
934LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
935 LLVMTypeRef DestTy, const char *Name);
936LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
937 LLVMTypeRef DestTy, const char *Name);
938LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
939 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000940LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
941 LLVMTypeRef DestTy, const char *Name);
942LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
943 LLVMTypeRef DestTy, const char *Name);
944LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
945 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000946LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
947 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000948LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
949 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000950LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000951 LLVMTypeRef DestTy, const char *Name);
952LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
953 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000954
955/* Comparisons */
956LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
957 LLVMValueRef LHS, LLVMValueRef RHS,
958 const char *Name);
959LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
960 LLVMValueRef LHS, LLVMValueRef RHS,
961 const char *Name);
962
963/* Miscellaneous instructions */
964LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
965LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
966 LLVMValueRef *Args, unsigned NumArgs,
967 const char *Name);
968LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
969 LLVMValueRef Then, LLVMValueRef Else,
970 const char *Name);
971LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
972 const char *Name);
973LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
974 LLVMValueRef Index, const char *Name);
975LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
976 LLVMValueRef EltVal, LLVMValueRef Index,
977 const char *Name);
978LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
979 LLVMValueRef V2, LLVMValueRef Mask,
980 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000981LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
982 unsigned Index, const char *Name);
983LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
984 LLVMValueRef EltVal, unsigned Index,
985 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000986
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000987LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
988 const char *Name);
989LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
990 const char *Name);
991LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
992 LLVMValueRef RHS, const char *Name);
993
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000994
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000995/*===-- Module providers --------------------------------------------------===*/
996
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000997/* Changes the type of M so it can be passed to FunctionPassManagers and the
998 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000999 */
1000LLVMModuleProviderRef
1001LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1002
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001003/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001004 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001005void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001006
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001007
1008/*===-- Memory buffers ----------------------------------------------------===*/
1009
Chris Lattner25963c62010-01-09 22:27:07 +00001010LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1011 LLVMMemoryBufferRef *OutMemBuf,
1012 char **OutMessage);
1013LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1014 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001015void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1016
Gordon Henriksen878114b2008-03-16 04:20:44 +00001017
1018/*===-- Pass Managers -----------------------------------------------------===*/
1019
1020/** Constructs a new whole-module pass pipeline. This type of pipeline is
1021 suitable for link-time optimization and whole-module transformations.
1022 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001023LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001024
1025/** Constructs a new function-by-function pass pipeline over the module
1026 provider. It does not take ownership of the module provider. This type of
1027 pipeline is suitable for code generation and JIT compilation tasks.
1028 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001029LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1030
1031/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001032LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1033
1034/** Initializes, executes on the provided module, and finalizes all of the
1035 passes scheduled in the pass manager. Returns 1 if any of the passes
1036 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001037LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001038
1039/** Initializes all of the function passes scheduled in the function pass
1040 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1041 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001042LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001043
1044/** Executes all of the function passes scheduled in the function pass manager
1045 on the provided function. Returns 1 if any of the passes modified the
1046 function, false otherwise.
1047 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001048LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001049
1050/** Finalizes all of the function passes scheduled in in the function pass
1051 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1052 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001053LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001054
1055/** Frees the memory of a pass pipeline. For function pipelines, does not free
1056 the module provider.
1057 See llvm::PassManagerBase::~PassManagerBase. */
1058void LLVMDisposePassManager(LLVMPassManagerRef PM);
1059
1060
Gordon Henriksen76a03742007-09-18 03:18:57 +00001061#ifdef __cplusplus
1062}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001063
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001064namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001065 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001066 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001067
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001068 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1069 inline ty *unwrap(ref P) { \
1070 return reinterpret_cast<ty*>(P); \
1071 } \
1072 \
1073 inline ref wrap(const ty *P) { \
1074 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1075 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001076
Gordon Henriksen878114b2008-03-16 04:20:44 +00001077 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1078 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1079 \
1080 template<typename T> \
1081 inline T *unwrap(ref P) { \
1082 return cast<T>(unwrap(P)); \
1083 }
1084
1085 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1086 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1087 \
1088 template<typename T> \
1089 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001090 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001091 assert(Q && "Invalid cast!"); \
1092 return Q; \
1093 }
1094
1095 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1096 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001097 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1098 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001099 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001100 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001101 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001102 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001103 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001104 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001105 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1106 * Module.
1107 */
1108 inline Module *unwrap(LLVMModuleProviderRef MP) {
1109 return reinterpret_cast<Module*>(MP);
1110 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001111
Gordon Henriksen878114b2008-03-16 04:20:44 +00001112 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1113 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001114 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001115
1116 /* Specialized opaque context conversions.
1117 */
1118 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1119 return reinterpret_cast<LLVMContext**>(Tys);
1120 }
1121
1122 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1123 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1124 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001125
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001126 /* Specialized opaque type conversions.
1127 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001128 inline Type **unwrap(LLVMTypeRef* Tys) {
1129 return reinterpret_cast<Type**>(Tys);
1130 }
1131
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001132 inline LLVMTypeRef *wrap(const Type **Tys) {
1133 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1134 }
1135
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001136 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001137 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001138 inline Value **unwrap(LLVMValueRef *Vals) {
1139 return reinterpret_cast<Value**>(Vals);
1140 }
1141
1142 template<typename T>
1143 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1144 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001145 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001146 cast<T>(*I);
1147 #endif
1148 return reinterpret_cast<T**>(Vals);
1149 }
1150
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001151 inline LLVMValueRef *wrap(const Value **Vals) {
1152 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1153 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001154}
1155
1156#endif /* !defined(__cplusplus) */
1157
1158#endif /* !defined(LLVM_C_CORE_H) */