blob: fdfc7e90fe9db766dde00a991c322c2bf4249723 [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
Chris Lattner40cf28d2009-10-12 04:01:02 +000095/**
96 * Used to iterate through the uses of a Value, allowing access to all Values
97 * that use this Value. See the llvm::Use and llvm::value_use_iterator classes.
98 */
99typedef struct LLVMOpaqueUseIterator *LLVMUseIteratorRef;
100
Gordon Henriksen76a03742007-09-18 03:18:57 +0000101typedef enum {
Devang Patel4c758ea2008-09-25 21:00:45 +0000102 LLVMZExtAttribute = 1<<0,
103 LLVMSExtAttribute = 1<<1,
104 LLVMNoReturnAttribute = 1<<2,
105 LLVMInRegAttribute = 1<<3,
106 LLVMStructRetAttribute = 1<<4,
107 LLVMNoUnwindAttribute = 1<<5,
108 LLVMNoAliasAttribute = 1<<6,
109 LLVMByValAttribute = 1<<7,
110 LLVMNestAttribute = 1<<8,
111 LLVMReadNoneAttribute = 1<<9,
Anton Korobeynikovc8ce7b082009-07-17 18:07:26 +0000112 LLVMReadOnlyAttribute = 1<<10,
Anton Korobeynikov9750be92009-07-17 18:57:16 +0000113 LLVMNoInlineAttribute = 1<<11,
114 LLVMAlwaysInlineAttribute = 1<<12,
115 LLVMOptimizeForSizeAttribute = 1<<13,
116 LLVMStackProtectAttribute = 1<<14,
117 LLVMStackProtectReqAttribute = 1<<15,
118 LLVMNoCaptureAttribute = 1<<21,
119 LLVMNoRedZoneAttribute = 1<<22,
120 LLVMNoImplicitFloatAttribute = 1<<23,
Jakob Stoklund Olesen74bb06c2010-02-06 01:16:28 +0000121 LLVMNakedAttribute = 1<<24,
122 LLVMInlineHintAttribute = 1<<25
Devang Patel4c758ea2008-09-25 21:00:45 +0000123} LLVMAttribute;
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000124
125typedef enum {
Bill Wendlingda52cec2010-02-15 20:53:17 +0000126 /* Terminator Instructions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000127 LLVMRet = 1,
128 LLVMBr = 2,
129 LLVMSwitch = 3,
Bill Wendling07d6d762010-02-15 20:50:51 +0000130 LLVMIndirectBr = 4,
131 LLVMInvoke = 5,
132 LLVMUnwind = 6,
133 LLVMUnreachable = 7,
134
Bill Wendlingda52cec2010-02-15 20:53:17 +0000135 /* Standard Binary Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000136 LLVMAdd = 8,
137 LLVMFAdd = 9,
138 LLVMSub = 10,
139 LLVMFSub = 11,
140 LLVMMul = 12,
141 LLVMFMul = 13,
142 LLVMUDiv = 14,
143 LLVMSDiv = 15,
144 LLVMFDiv = 16,
145 LLVMURem = 17,
146 LLVMSRem = 18,
147 LLVMFRem = 19,
148
Bill Wendlingda52cec2010-02-15 20:53:17 +0000149 /* Logical Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000150 LLVMShl = 20,
151 LLVMLShr = 21,
152 LLVMAShr = 22,
153 LLVMAnd = 23,
154 LLVMOr = 24,
155 LLVMXor = 25,
156
Bill Wendlingda52cec2010-02-15 20:53:17 +0000157 /* Memory Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000158 LLVMAlloca = 26,
159 LLVMLoad = 27,
160 LLVMStore = 28,
161 LLVMGetElementPtr = 29,
162
Bill Wendlingda52cec2010-02-15 20:53:17 +0000163 /* Cast Operators */
Erick Tryzelaar5bf1a322010-02-16 03:45:23 +0000164 LLVMTrunc = 30,
Bill Wendling07d6d762010-02-15 20:50:51 +0000165 LLVMZExt = 31,
166 LLVMSExt = 32,
167 LLVMFPToUI = 33,
168 LLVMFPToSI = 34,
169 LLVMUIToFP = 35,
170 LLVMSIToFP = 36,
171 LLVMFPTrunc = 37,
172 LLVMFPExt = 38,
173 LLVMPtrToInt = 39,
174 LLVMIntToPtr = 40,
175 LLVMBitCast = 41,
176
Bill Wendlingda52cec2010-02-15 20:53:17 +0000177 /* Other Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000178 LLVMICmp = 42,
179 LLVMFCmp = 43,
180 LLVMPHI = 44,
181 LLVMCall = 45,
182 LLVMSelect = 46,
Bill Wendlingda52cec2010-02-15 20:53:17 +0000183 /* UserOp1 */
184 /* UserOp2 */
Bill Wendling07d6d762010-02-15 20:50:51 +0000185 LLVMVAArg = 49,
186 LLVMExtractElement = 50,
187 LLVMInsertElement = 51,
188 LLVMShuffleVector = 52,
189 LLVMExtractValue = 53,
190 LLVMInsertValue = 54
Chris Lattner40cf28d2009-10-12 04:01:02 +0000191} LLVMOpcode;
192
193typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000194 LLVMVoidTypeKind, /**< type with no size */
195 LLVMFloatTypeKind, /**< 32 bit floating point type */
196 LLVMDoubleTypeKind, /**< 64 bit floating point type */
197 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
198 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
199 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
200 LLVMLabelTypeKind, /**< Labels */
201 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
202 LLVMFunctionTypeKind, /**< Functions */
203 LLVMStructTypeKind, /**< Structures */
204 LLVMArrayTypeKind, /**< Arrays */
205 LLVMPointerTypeKind, /**< Pointers */
206 LLVMOpaqueTypeKind, /**< Opaque: type with unknown structure */
Chris Lattnerdac44ec2009-07-15 22:00:31 +0000207 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
Chris Lattner392be582010-02-12 20:49:41 +0000208 LLVMMetadataTypeKind, /**< Metadata */
209 LLVMUnionTypeKind /**< Unions */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000210} LLVMTypeKind;
211
212typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000213 LLVMExternalLinkage, /**< Externally visible function */
Chris Lattner2dba0f02009-04-13 06:25:37 +0000214 LLVMAvailableExternallyLinkage,
Duncan Sands12da8ce2009-03-07 15:45:40 +0000215 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
216 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
217 equivalent. */
218 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
219 LLVMWeakODRLinkage, /**< Same, but only replaced by something
220 equivalent. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000221 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
222 LLVMInternalLinkage, /**< Rename collisions when linking (static
223 functions) */
Duncan Sands12da8ce2009-03-07 15:45:40 +0000224 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000225 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
226 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
Duncan Sandse2881052009-03-11 08:08:06 +0000227 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000228 LLVMGhostLinkage, /**< Obsolete */
Bill Wendling002b1672009-07-20 18:22:52 +0000229 LLVMCommonLinkage, /**< Tentative definitions */
230 LLVMLinkerPrivateLinkage /**< Like Private, but linker removes. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000231} LLVMLinkage;
232
233typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000234 LLVMDefaultVisibility, /**< The GV is visible */
235 LLVMHiddenVisibility, /**< The GV is hidden */
236 LLVMProtectedVisibility /**< The GV is protected */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000237} LLVMVisibility;
238
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000239typedef enum {
240 LLVMCCallConv = 0,
241 LLVMFastCallConv = 8,
242 LLVMColdCallConv = 9,
243 LLVMX86StdcallCallConv = 64,
244 LLVMX86FastcallCallConv = 65
245} LLVMCallConv;
246
247typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000248 LLVMIntEQ = 32, /**< equal */
249 LLVMIntNE, /**< not equal */
250 LLVMIntUGT, /**< unsigned greater than */
251 LLVMIntUGE, /**< unsigned greater or equal */
252 LLVMIntULT, /**< unsigned less than */
253 LLVMIntULE, /**< unsigned less or equal */
254 LLVMIntSGT, /**< signed greater than */
255 LLVMIntSGE, /**< signed greater or equal */
256 LLVMIntSLT, /**< signed less than */
257 LLVMIntSLE /**< signed less or equal */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000258} LLVMIntPredicate;
259
260typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000261 LLVMRealPredicateFalse, /**< Always false (always folded) */
262 LLVMRealOEQ, /**< True if ordered and equal */
263 LLVMRealOGT, /**< True if ordered and greater than */
264 LLVMRealOGE, /**< True if ordered and greater than or equal */
265 LLVMRealOLT, /**< True if ordered and less than */
266 LLVMRealOLE, /**< True if ordered and less than or equal */
267 LLVMRealONE, /**< True if ordered and operands are unequal */
268 LLVMRealORD, /**< True if ordered (no nans) */
269 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
270 LLVMRealUEQ, /**< True if unordered or equal */
271 LLVMRealUGT, /**< True if unordered or greater than */
272 LLVMRealUGE, /**< True if unordered, greater than, or equal */
273 LLVMRealULT, /**< True if unordered or less than */
274 LLVMRealULE, /**< True if unordered, less than, or equal */
275 LLVMRealUNE, /**< True if unordered or not equal */
276 LLVMRealPredicateTrue /**< Always true (always folded) */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000277} LLVMRealPredicate;
278
Gordon Henriksen76a03742007-09-18 03:18:57 +0000279
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000280/*===-- Error handling ----------------------------------------------------===*/
281
282void LLVMDisposeMessage(char *Message);
283
284
Gordon Henriksen76a03742007-09-18 03:18:57 +0000285/*===-- Modules -----------------------------------------------------------===*/
286
Owen Anderson6773d382009-07-01 16:58:40 +0000287/* Create and destroy contexts. */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000288LLVMContextRef LLVMContextCreate(void);
289LLVMContextRef LLVMGetGlobalContext(void);
Owen Anderson6773d382009-07-01 16:58:40 +0000290void LLVMContextDispose(LLVMContextRef C);
291
Gordon Henriksen76a03742007-09-18 03:18:57 +0000292/* Create and destroy modules. */
Gordon Henriksena49d4352008-03-07 19:13:06 +0000293/** See llvm::Module::Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000294LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Owen Anderson31d44e42009-07-02 07:17:57 +0000295LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
296 LLVMContextRef C);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000297
298/** See llvm::Module::~Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000299void LLVMDisposeModule(LLVMModuleRef M);
300
Gordon Henriksena49d4352008-03-07 19:13:06 +0000301/** Data layout. See Module::getDataLayout. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000302const char *LLVMGetDataLayout(LLVMModuleRef M);
303void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
304
Gordon Henriksena49d4352008-03-07 19:13:06 +0000305/** Target triple. See Module::getTargetTriple. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000306const char *LLVMGetTarget(LLVMModuleRef M);
307void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
308
Gordon Henriksena49d4352008-03-07 19:13:06 +0000309/** See Module::addTypeName. */
Chris Lattner25963c62010-01-09 22:27:07 +0000310LLVMBool LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000311void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
Chris Lattner7f318242009-07-06 17:29:59 +0000312LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000313
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000314/** See Module::dump. */
315void LLVMDumpModule(LLVMModuleRef M);
316
Gordon Henriksen76a03742007-09-18 03:18:57 +0000317
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000318/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000319
320/* LLVM types conform to the following hierarchy:
321 *
322 * types:
323 * integer type
324 * real type
325 * function type
326 * sequence types:
327 * array type
328 * pointer type
329 * vector type
330 * void type
331 * label type
332 * opaque type
333 */
334
Gordon Henriksena49d4352008-03-07 19:13:06 +0000335/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000336LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000337
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000338/** See llvm::LLVMType::getContext. */
339LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
340
Gordon Henriksen76a03742007-09-18 03:18:57 +0000341/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000342LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
343LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
344LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
345LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
346LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
347LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
348
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000349LLVMTypeRef LLVMInt1Type(void);
350LLVMTypeRef LLVMInt8Type(void);
351LLVMTypeRef LLVMInt16Type(void);
352LLVMTypeRef LLVMInt32Type(void);
353LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000354LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000355unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000356
357/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000358LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
359LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
360LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
361LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
362LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
363
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000364LLVMTypeRef LLVMFloatType(void);
365LLVMTypeRef LLVMDoubleType(void);
366LLVMTypeRef LLVMX86FP80Type(void);
367LLVMTypeRef LLVMFP128Type(void);
368LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000369
370/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000371LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
372 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000373 LLVMBool IsVarArg);
374LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000375LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
376unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
377void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000378
379/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000380LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000381 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000382LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000383 LLVMBool Packed);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000384unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000385void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000386LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000387
Chris Lattner392be582010-02-12 20:49:41 +0000388/* Operations on union types */
389LLVMTypeRef LLVMUnionTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
390 unsigned ElementCount);
391LLVMTypeRef LLVMUnionType(LLVMTypeRef *ElementTypes, unsigned ElementCount);
392unsigned LLVMCountUnionElementTypes(LLVMTypeRef UnionTy);
393void LLVMGetUnionElementTypes(LLVMTypeRef UnionTy, LLVMTypeRef *Dest);
394
Gordon Henriksen76a03742007-09-18 03:18:57 +0000395/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000396LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000397LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000398LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000399
400LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
401unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000402unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000403unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
404
405/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000406LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
407LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
408LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
409
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000410LLVMTypeRef LLVMVoidType(void);
411LLVMTypeRef LLVMLabelType(void);
412LLVMTypeRef LLVMOpaqueType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000413
Gordon Henriksenffb48762007-10-07 00:13:35 +0000414/* Operations on type handles */
415LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
416void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
417LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
418void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
419
Gordon Henriksen76a03742007-09-18 03:18:57 +0000420
421/*===-- Values ------------------------------------------------------------===*/
422
423/* The bulk of LLVM's object model consists of values, which comprise a very
424 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000425 */
426
Gordon Henriksen29e38942008-12-19 18:39:45 +0000427#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
428 macro(Argument) \
429 macro(BasicBlock) \
430 macro(InlineAsm) \
431 macro(User) \
432 macro(Constant) \
433 macro(ConstantAggregateZero) \
434 macro(ConstantArray) \
435 macro(ConstantExpr) \
436 macro(ConstantFP) \
437 macro(ConstantInt) \
438 macro(ConstantPointerNull) \
439 macro(ConstantStruct) \
440 macro(ConstantVector) \
441 macro(GlobalValue) \
442 macro(Function) \
443 macro(GlobalAlias) \
444 macro(GlobalVariable) \
445 macro(UndefValue) \
446 macro(Instruction) \
447 macro(BinaryOperator) \
448 macro(CallInst) \
449 macro(IntrinsicInst) \
450 macro(DbgInfoIntrinsic) \
451 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000452 macro(EHSelectorInst) \
453 macro(MemIntrinsic) \
454 macro(MemCpyInst) \
455 macro(MemMoveInst) \
456 macro(MemSetInst) \
457 macro(CmpInst) \
458 macro(FCmpInst) \
459 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000460 macro(ExtractElementInst) \
461 macro(GetElementPtrInst) \
462 macro(InsertElementInst) \
463 macro(InsertValueInst) \
464 macro(PHINode) \
465 macro(SelectInst) \
466 macro(ShuffleVectorInst) \
467 macro(StoreInst) \
468 macro(TerminatorInst) \
469 macro(BranchInst) \
470 macro(InvokeInst) \
471 macro(ReturnInst) \
472 macro(SwitchInst) \
473 macro(UnreachableInst) \
474 macro(UnwindInst) \
475 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000476 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000477 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000478 macro(BitCastInst) \
479 macro(FPExtInst) \
480 macro(FPToSIInst) \
481 macro(FPToUIInst) \
482 macro(FPTruncInst) \
483 macro(IntToPtrInst) \
484 macro(PtrToIntInst) \
485 macro(SExtInst) \
486 macro(SIToFPInst) \
487 macro(TruncInst) \
488 macro(UIToFPInst) \
489 macro(ZExtInst) \
490 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000491 macro(LoadInst) \
492 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000493
Gordon Henriksen76a03742007-09-18 03:18:57 +0000494/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000495LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000496const char *LLVMGetValueName(LLVMValueRef Val);
497void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000498void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000499void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000500
Gordon Henriksen29e38942008-12-19 18:39:45 +0000501/* Conversion functions. Return the input value if it is an instance of the
502 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
503#define LLVM_DECLARE_VALUE_CAST(name) \
504 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
505LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
506
Chris Lattner40cf28d2009-10-12 04:01:02 +0000507/* Operations on Uses */
508LLVMUseIteratorRef LLVMGetFirstUse(LLVMValueRef Val);
509LLVMUseIteratorRef LLVMGetNextUse(LLVMUseIteratorRef U);
510LLVMValueRef LLVMGetUser(LLVMUseIteratorRef U);
511LLVMValueRef LLVMGetUsedValue(LLVMUseIteratorRef U);
512
513/* Operations on Users */
514LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
515
Gordon Henriksen76a03742007-09-18 03:18:57 +0000516/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000517LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
518LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000519LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000520LLVMBool LLVMIsConstant(LLVMValueRef Val);
521LLVMBool LLVMIsNull(LLVMValueRef Val);
522LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000523LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000524
525/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000526LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000527 LLVMBool SignExtend);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000528LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
529 uint8_t Radix);
530LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
531 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000532LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000533LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000534LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
535 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000536unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
537long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000538
Gordon Henriksen76a03742007-09-18 03:18:57 +0000539
540/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000541LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000542 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000543LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
544 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000545 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000546
Gordon Henriksen1046c732007-10-06 15:11:06 +0000547LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000548 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000549LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000550 LLVMValueRef *ConstantVals, unsigned Length);
551LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000552 LLVMBool Packed);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000553LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000554
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000555/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000556LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000557LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000558LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
559LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000560LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000561LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
562LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000563LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000564LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000565LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000566LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000567LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000568LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000569LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
570LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000571LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000572LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
573LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
574LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
575LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
576LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
577LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
578LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
579LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
580 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
581LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
582 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
583LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
584LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
585LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
586LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
587 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000588LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
589 LLVMValueRef *ConstantIndices,
590 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000591LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
592LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
593LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
594LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
595LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
596LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
597LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
598LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
599LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
600LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
601LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
602LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000603LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
604 LLVMTypeRef ToType);
605LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
606 LLVMTypeRef ToType);
607LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
608 LLVMTypeRef ToType);
609LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
610 LLVMTypeRef ToType);
611LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000612 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000613LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000614LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
615 LLVMValueRef ConstantIfTrue,
616 LLVMValueRef ConstantIfFalse);
617LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
618 LLVMValueRef IndexConstant);
619LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
620 LLVMValueRef ElementValueConstant,
621 LLVMValueRef IndexConstant);
622LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
623 LLVMValueRef VectorBConstant,
624 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000625LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
626 unsigned NumIdx);
627LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
628 LLVMValueRef ElementValueConstant,
629 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000630LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000631 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000632 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000633
Gordon Henriksen76a03742007-09-18 03:18:57 +0000634/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000635LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000636LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000637LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
638void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
639const char *LLVMGetSection(LLVMValueRef Global);
640void LLVMSetSection(LLVMValueRef Global, const char *Section);
641LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
642void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
643unsigned LLVMGetAlignment(LLVMValueRef Global);
644void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
645
646/* Operations on global variables */
647LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000648LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000649LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
650LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
651LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
652LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000653void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000654LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
655void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000656LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
657void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
658LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
659void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000660
Chris Lattner3d1f5522008-12-17 21:39:50 +0000661/* Operations on aliases */
662LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
663 const char *Name);
664
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000665/* Operations on functions */
666LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
667 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000668LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000669LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
670LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
671LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
672LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000673void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000674unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
675unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
676void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000677const char *LLVMGetGC(LLVMValueRef Fn);
678void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000679void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000680LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000681void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000682
Gordon Henriksen265f7802008-03-19 01:11:35 +0000683/* Operations on parameters */
684unsigned LLVMCountParams(LLVMValueRef Fn);
685void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
686LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
687LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000688LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
689LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
690LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
691LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000692void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
693void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000694LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000695void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000696
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000697/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000698LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000699LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000700LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000701LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000702unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
703void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000704LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
705LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
706LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
707LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000708LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000709
710LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
711 LLVMValueRef Fn,
712 const char *Name);
713LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
714 LLVMBasicBlockRef BB,
715 const char *Name);
716
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000717LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
718LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
719 const char *Name);
720void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
721
Gordon Henriksen265f7802008-03-19 01:11:35 +0000722/* Operations on instructions */
723LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000724LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
725LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
726LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
727LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000728
Gordon Henriksen1158c532007-12-29 20:45:00 +0000729/* Operations on call sites */
730void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
731unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000732void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
733void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
734 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000735void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
736 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000737
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000738/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000739LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
740void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000741
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000742/* Operations on phi nodes */
743void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
744 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
745unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
746LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
747LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000748
749/*===-- Instruction builders ----------------------------------------------===*/
750
751/* An instruction builder represents a point within a basic block, and is the
752 * exclusive means of building instructions using the C interface.
753 */
754
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000755LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000756LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000757void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
758 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000759void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
760void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000761LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000762void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
763void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000764void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
765 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000766void LLVMDisposeBuilder(LLVMBuilderRef Builder);
767
768/* Terminators */
769LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
770LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000771LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000772 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000773LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
774LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
775 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
776LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
777 LLVMBasicBlockRef Else, unsigned NumCases);
778LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
779 LLVMValueRef *Args, unsigned NumArgs,
780 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
781 const char *Name);
782LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
783LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
784
Gordon Henriksen097102c2008-01-01 05:50:53 +0000785/* Add a case to the switch instruction */
786void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
787 LLVMBasicBlockRef Dest);
788
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000789/* Arithmetic */
790LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
791 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000792LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
793 const char *Name);
794LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
795 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000796LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
797 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000798LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
799 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000800LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
801 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000802LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
803 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000804LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
805 const char *Name);
806LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
807 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000808LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
809 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000810LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
811 const char *Name);
812LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
813 const char *Name);
814LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
815 const char *Name);
816LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
817 const char *Name);
818LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
819 const char *Name);
820LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
821 const char *Name);
822LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
823 const char *Name);
824LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
825 const char *Name);
826LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
827 const char *Name);
828LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
829 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000830LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
831 LLVMValueRef LHS, LLVMValueRef RHS,
832 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000833LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000834LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000835LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
836
837/* Memory */
838LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
839LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
840 LLVMValueRef Val, const char *Name);
841LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
842LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
843 LLVMValueRef Val, const char *Name);
844LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
845LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
846 const char *Name);
847LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
848LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
849 LLVMValueRef *Indices, unsigned NumIndices,
850 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000851LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
852 LLVMValueRef *Indices, unsigned NumIndices,
853 const char *Name);
854LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
855 unsigned Idx, const char *Name);
856LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
857 const char *Name);
858LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
859 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000860
861/* Casts */
862LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
863 LLVMTypeRef DestTy, const char *Name);
864LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
865 LLVMTypeRef DestTy, const char *Name);
866LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
867 LLVMTypeRef DestTy, const char *Name);
868LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
869 LLVMTypeRef DestTy, const char *Name);
870LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
871 LLVMTypeRef DestTy, const char *Name);
872LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
873 LLVMTypeRef DestTy, const char *Name);
874LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
875 LLVMTypeRef DestTy, const char *Name);
876LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
877 LLVMTypeRef DestTy, const char *Name);
878LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
879 LLVMTypeRef DestTy, const char *Name);
880LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
881 LLVMTypeRef DestTy, const char *Name);
882LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
883 LLVMTypeRef DestTy, const char *Name);
884LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
885 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000886LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
887 LLVMTypeRef DestTy, const char *Name);
888LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
889 LLVMTypeRef DestTy, const char *Name);
890LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
891 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000892LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
893 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000894LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
895 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000896LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000897 LLVMTypeRef DestTy, const char *Name);
898LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
899 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000900
901/* Comparisons */
902LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
903 LLVMValueRef LHS, LLVMValueRef RHS,
904 const char *Name);
905LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
906 LLVMValueRef LHS, LLVMValueRef RHS,
907 const char *Name);
908
909/* Miscellaneous instructions */
910LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
911LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
912 LLVMValueRef *Args, unsigned NumArgs,
913 const char *Name);
914LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
915 LLVMValueRef Then, LLVMValueRef Else,
916 const char *Name);
917LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
918 const char *Name);
919LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
920 LLVMValueRef Index, const char *Name);
921LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
922 LLVMValueRef EltVal, LLVMValueRef Index,
923 const char *Name);
924LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
925 LLVMValueRef V2, LLVMValueRef Mask,
926 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000927LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
928 unsigned Index, const char *Name);
929LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
930 LLVMValueRef EltVal, unsigned Index,
931 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000932
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000933LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
934 const char *Name);
935LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
936 const char *Name);
937LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
938 LLVMValueRef RHS, const char *Name);
939
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000940
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000941/*===-- Module providers --------------------------------------------------===*/
942
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000943/* Changes the type of M so it can be passed to FunctionPassManagers and the
944 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000945 */
946LLVMModuleProviderRef
947LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
948
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000949/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000950 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000951void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000952
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000953
954/*===-- Memory buffers ----------------------------------------------------===*/
955
Chris Lattner25963c62010-01-09 22:27:07 +0000956LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
957 LLVMMemoryBufferRef *OutMemBuf,
958 char **OutMessage);
959LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
960 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000961void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
962
Gordon Henriksen878114b2008-03-16 04:20:44 +0000963
964/*===-- Pass Managers -----------------------------------------------------===*/
965
966/** Constructs a new whole-module pass pipeline. This type of pipeline is
967 suitable for link-time optimization and whole-module transformations.
968 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000969LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +0000970
971/** Constructs a new function-by-function pass pipeline over the module
972 provider. It does not take ownership of the module provider. This type of
973 pipeline is suitable for code generation and JIT compilation tasks.
974 See llvm::FunctionPassManager::FunctionPassManager. */
975LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
976
977/** Initializes, executes on the provided module, and finalizes all of the
978 passes scheduled in the pass manager. Returns 1 if any of the passes
979 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +0000980LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +0000981
982/** Initializes all of the function passes scheduled in the function pass
983 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
984 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +0000985LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +0000986
987/** Executes all of the function passes scheduled in the function pass manager
988 on the provided function. Returns 1 if any of the passes modified the
989 function, false otherwise.
990 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +0000991LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +0000992
993/** Finalizes all of the function passes scheduled in in the function pass
994 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
995 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +0000996LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +0000997
998/** Frees the memory of a pass pipeline. For function pipelines, does not free
999 the module provider.
1000 See llvm::PassManagerBase::~PassManagerBase. */
1001void LLVMDisposePassManager(LLVMPassManagerRef PM);
1002
1003
Gordon Henriksen76a03742007-09-18 03:18:57 +00001004#ifdef __cplusplus
1005}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001006
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001007namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001008 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001009 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001010
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001011 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1012 inline ty *unwrap(ref P) { \
1013 return reinterpret_cast<ty*>(P); \
1014 } \
1015 \
1016 inline ref wrap(const ty *P) { \
1017 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1018 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001019
Gordon Henriksen878114b2008-03-16 04:20:44 +00001020 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1021 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1022 \
1023 template<typename T> \
1024 inline T *unwrap(ref P) { \
1025 return cast<T>(unwrap(P)); \
1026 }
1027
1028 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1029 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1030 \
1031 template<typename T> \
1032 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001033 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001034 assert(Q && "Invalid cast!"); \
1035 return Q; \
1036 }
1037
1038 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1039 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001040 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1041 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001042 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001043 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001044 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001045 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Chris Lattner40cf28d2009-10-12 04:01:02 +00001046 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseIteratorRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001047 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001048 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1049 * Module.
1050 */
1051 inline Module *unwrap(LLVMModuleProviderRef MP) {
1052 return reinterpret_cast<Module*>(MP);
1053 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001054
Gordon Henriksen878114b2008-03-16 04:20:44 +00001055 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1056 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001057 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001058
1059 /* Specialized opaque context conversions.
1060 */
1061 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1062 return reinterpret_cast<LLVMContext**>(Tys);
1063 }
1064
1065 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1066 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1067 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001068
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001069 /* Specialized opaque type conversions.
1070 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001071 inline Type **unwrap(LLVMTypeRef* Tys) {
1072 return reinterpret_cast<Type**>(Tys);
1073 }
1074
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001075 inline LLVMTypeRef *wrap(const Type **Tys) {
1076 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1077 }
1078
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001079 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001080 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001081 inline Value **unwrap(LLVMValueRef *Vals) {
1082 return reinterpret_cast<Value**>(Vals);
1083 }
1084
1085 template<typename T>
1086 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1087 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001088 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001089 cast<T>(*I);
1090 #endif
1091 return reinterpret_cast<T**>(Vals);
1092 }
1093
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001094 inline LLVMValueRef *wrap(const Value **Vals) {
1095 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1096 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001097}
1098
1099#endif /* !defined(__cplusplus) */
1100
1101#endif /* !defined(LLVM_C_CORE_H) */