blob: bdbf3f21f67c3d0bad6eeb588d8dfda24898240c [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
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000285/*===-- Contexts ----------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000286
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
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000292unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
293 unsigned SLen);
294unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
295
296/*===-- Modules -----------------------------------------------------------===*/
297
Gordon Henriksen76a03742007-09-18 03:18:57 +0000298/* Create and destroy modules. */
Gordon Henriksena49d4352008-03-07 19:13:06 +0000299/** See llvm::Module::Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000300LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Owen Anderson31d44e42009-07-02 07:17:57 +0000301LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
302 LLVMContextRef C);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000303
304/** See llvm::Module::~Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000305void LLVMDisposeModule(LLVMModuleRef M);
306
Gordon Henriksena49d4352008-03-07 19:13:06 +0000307/** Data layout. See Module::getDataLayout. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000308const char *LLVMGetDataLayout(LLVMModuleRef M);
309void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
310
Gordon Henriksena49d4352008-03-07 19:13:06 +0000311/** Target triple. See Module::getTargetTriple. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000312const char *LLVMGetTarget(LLVMModuleRef M);
313void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
314
Gordon Henriksena49d4352008-03-07 19:13:06 +0000315/** See Module::addTypeName. */
Chris Lattner25963c62010-01-09 22:27:07 +0000316LLVMBool LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000317void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
Chris Lattner7f318242009-07-06 17:29:59 +0000318LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000319
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000320/** See Module::dump. */
321void LLVMDumpModule(LLVMModuleRef M);
322
Gordon Henriksen76a03742007-09-18 03:18:57 +0000323
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000324/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000325
326/* LLVM types conform to the following hierarchy:
327 *
328 * types:
329 * integer type
330 * real type
331 * function type
332 * sequence types:
333 * array type
334 * pointer type
335 * vector type
336 * void type
337 * label type
338 * opaque type
339 */
340
Gordon Henriksena49d4352008-03-07 19:13:06 +0000341/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000342LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000343
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000344/** See llvm::LLVMType::getContext. */
345LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
346
Gordon Henriksen76a03742007-09-18 03:18:57 +0000347/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000348LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
349LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
350LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
351LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
352LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
353LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
354
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000355LLVMTypeRef LLVMInt1Type(void);
356LLVMTypeRef LLVMInt8Type(void);
357LLVMTypeRef LLVMInt16Type(void);
358LLVMTypeRef LLVMInt32Type(void);
359LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000360LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000361unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000362
363/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000364LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
365LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
366LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
367LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
368LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
369
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000370LLVMTypeRef LLVMFloatType(void);
371LLVMTypeRef LLVMDoubleType(void);
372LLVMTypeRef LLVMX86FP80Type(void);
373LLVMTypeRef LLVMFP128Type(void);
374LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000375
376/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000377LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
378 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000379 LLVMBool IsVarArg);
380LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000381LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
382unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
383void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000384
385/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000386LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000387 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000388LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000389 LLVMBool Packed);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000390unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000391void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000392LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000393
Chris Lattner392be582010-02-12 20:49:41 +0000394/* Operations on union types */
395LLVMTypeRef LLVMUnionTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
396 unsigned ElementCount);
397LLVMTypeRef LLVMUnionType(LLVMTypeRef *ElementTypes, unsigned ElementCount);
398unsigned LLVMCountUnionElementTypes(LLVMTypeRef UnionTy);
399void LLVMGetUnionElementTypes(LLVMTypeRef UnionTy, LLVMTypeRef *Dest);
400
Gordon Henriksen76a03742007-09-18 03:18:57 +0000401/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000402LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000403LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000404LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000405
406LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
407unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000408unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000409unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
410
411/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000412LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
413LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
414LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
415
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000416LLVMTypeRef LLVMVoidType(void);
417LLVMTypeRef LLVMLabelType(void);
418LLVMTypeRef LLVMOpaqueType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000419
Gordon Henriksenffb48762007-10-07 00:13:35 +0000420/* Operations on type handles */
421LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
422void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
423LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
424void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
425
Gordon Henriksen76a03742007-09-18 03:18:57 +0000426
427/*===-- Values ------------------------------------------------------------===*/
428
429/* The bulk of LLVM's object model consists of values, which comprise a very
430 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000431 */
432
Gordon Henriksen29e38942008-12-19 18:39:45 +0000433#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
434 macro(Argument) \
435 macro(BasicBlock) \
436 macro(InlineAsm) \
437 macro(User) \
438 macro(Constant) \
439 macro(ConstantAggregateZero) \
440 macro(ConstantArray) \
441 macro(ConstantExpr) \
442 macro(ConstantFP) \
443 macro(ConstantInt) \
444 macro(ConstantPointerNull) \
445 macro(ConstantStruct) \
446 macro(ConstantVector) \
447 macro(GlobalValue) \
448 macro(Function) \
449 macro(GlobalAlias) \
450 macro(GlobalVariable) \
451 macro(UndefValue) \
452 macro(Instruction) \
453 macro(BinaryOperator) \
454 macro(CallInst) \
455 macro(IntrinsicInst) \
456 macro(DbgInfoIntrinsic) \
457 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000458 macro(EHSelectorInst) \
459 macro(MemIntrinsic) \
460 macro(MemCpyInst) \
461 macro(MemMoveInst) \
462 macro(MemSetInst) \
463 macro(CmpInst) \
464 macro(FCmpInst) \
465 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000466 macro(ExtractElementInst) \
467 macro(GetElementPtrInst) \
468 macro(InsertElementInst) \
469 macro(InsertValueInst) \
470 macro(PHINode) \
471 macro(SelectInst) \
472 macro(ShuffleVectorInst) \
473 macro(StoreInst) \
474 macro(TerminatorInst) \
475 macro(BranchInst) \
476 macro(InvokeInst) \
477 macro(ReturnInst) \
478 macro(SwitchInst) \
479 macro(UnreachableInst) \
480 macro(UnwindInst) \
481 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000482 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000483 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000484 macro(BitCastInst) \
485 macro(FPExtInst) \
486 macro(FPToSIInst) \
487 macro(FPToUIInst) \
488 macro(FPTruncInst) \
489 macro(IntToPtrInst) \
490 macro(PtrToIntInst) \
491 macro(SExtInst) \
492 macro(SIToFPInst) \
493 macro(TruncInst) \
494 macro(UIToFPInst) \
495 macro(ZExtInst) \
496 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000497 macro(LoadInst) \
498 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000499
Gordon Henriksen76a03742007-09-18 03:18:57 +0000500/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000501LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000502const char *LLVMGetValueName(LLVMValueRef Val);
503void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000504void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000505void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000506int LLVMHasMetadata(LLVMValueRef Val);
507LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
508void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000509
Gordon Henriksen29e38942008-12-19 18:39:45 +0000510/* Conversion functions. Return the input value if it is an instance of the
511 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
512#define LLVM_DECLARE_VALUE_CAST(name) \
513 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
514LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
515
Chris Lattner40cf28d2009-10-12 04:01:02 +0000516/* Operations on Uses */
517LLVMUseIteratorRef LLVMGetFirstUse(LLVMValueRef Val);
518LLVMUseIteratorRef LLVMGetNextUse(LLVMUseIteratorRef U);
519LLVMValueRef LLVMGetUser(LLVMUseIteratorRef U);
520LLVMValueRef LLVMGetUsedValue(LLVMUseIteratorRef U);
521
522/* Operations on Users */
523LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
524
Gordon Henriksen76a03742007-09-18 03:18:57 +0000525/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000526LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
527LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000528LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000529LLVMBool LLVMIsConstant(LLVMValueRef Val);
530LLVMBool LLVMIsNull(LLVMValueRef Val);
531LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000532LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000533
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000534/* Operations on metadata */
535LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
536 unsigned SLen);
537LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
538LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
539 unsigned Count);
540LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
541
Gordon Henriksen76a03742007-09-18 03:18:57 +0000542/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000543LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000544 LLVMBool SignExtend);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000545LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
546 uint8_t Radix);
547LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
548 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000549LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000550LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000551LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
552 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000553unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
554long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000555
Gordon Henriksen76a03742007-09-18 03:18:57 +0000556
557/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000558LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000559 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000560LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
561 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000562 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000563
Gordon Henriksen1046c732007-10-06 15:11:06 +0000564LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000565 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000566LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000567 LLVMValueRef *ConstantVals, unsigned Length);
568LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000569 LLVMBool Packed);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000570LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Erick Tryzelaara8053df2010-02-28 05:51:33 +0000571LLVMValueRef LLVMConstUnion(LLVMTypeRef Ty, LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000572
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000573/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000574LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000575LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000576LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
577LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000578LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
579LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000580LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000581LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
582LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000583LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000584LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000585LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000586LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000587LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
588LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000589LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000590LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000591LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
592LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000593LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000594LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
595LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000596LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000597LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
598LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
599LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
600LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
601LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
602LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
604LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
605 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
606LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
607 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
609LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
611LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
612 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000613LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
614 LLVMValueRef *ConstantIndices,
615 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000616LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
617LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
618LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
619LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
620LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
621LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
622LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
623LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
624LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
625LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
626LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
627LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000628LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
629 LLVMTypeRef ToType);
630LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
631 LLVMTypeRef ToType);
632LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
633 LLVMTypeRef ToType);
634LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
635 LLVMTypeRef ToType);
636LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000637 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000638LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000639LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
640 LLVMValueRef ConstantIfTrue,
641 LLVMValueRef ConstantIfFalse);
642LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
643 LLVMValueRef IndexConstant);
644LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
645 LLVMValueRef ElementValueConstant,
646 LLVMValueRef IndexConstant);
647LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
648 LLVMValueRef VectorBConstant,
649 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000650LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
651 unsigned NumIdx);
652LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
653 LLVMValueRef ElementValueConstant,
654 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000655LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000656 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000657 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000658LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000659
Gordon Henriksen76a03742007-09-18 03:18:57 +0000660/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000661LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000662LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000663LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
664void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
665const char *LLVMGetSection(LLVMValueRef Global);
666void LLVMSetSection(LLVMValueRef Global, const char *Section);
667LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
668void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
669unsigned LLVMGetAlignment(LLVMValueRef Global);
670void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
671
672/* Operations on global variables */
673LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000674LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
675 const char *Name,
676 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000677LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000678LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
679LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
680LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
681LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000682void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000683LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
684void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000685LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
686void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
687LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
688void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000689
Chris Lattner3d1f5522008-12-17 21:39:50 +0000690/* Operations on aliases */
691LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
692 const char *Name);
693
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000694/* Operations on functions */
695LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
696 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000697LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000698LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
699LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
700LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
701LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000702void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000703unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
704unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
705void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000706const char *LLVMGetGC(LLVMValueRef Fn);
707void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000708void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000709LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000710void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000711
Gordon Henriksen265f7802008-03-19 01:11:35 +0000712/* Operations on parameters */
713unsigned LLVMCountParams(LLVMValueRef Fn);
714void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
715LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
716LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000717LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
718LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
719LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
720LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000721void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
722void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000723LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000724void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000725
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000726/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000727LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000728LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000729LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000730LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000731unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
732void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000733LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
734LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
735LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
736LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000737LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000738
739LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
740 LLVMValueRef Fn,
741 const char *Name);
742LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
743 LLVMBasicBlockRef BB,
744 const char *Name);
745
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000746LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
747LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
748 const char *Name);
749void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
750
Gordon Henriksen265f7802008-03-19 01:11:35 +0000751/* Operations on instructions */
752LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000753LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
754LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
755LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
756LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000757
Gordon Henriksen1158c532007-12-29 20:45:00 +0000758/* Operations on call sites */
759void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
760unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000761void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
762void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
763 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000764void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
765 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000766
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000767/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000768LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
769void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000770
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000771/* Operations on phi nodes */
772void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
773 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
774unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
775LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
776LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000777
778/*===-- Instruction builders ----------------------------------------------===*/
779
780/* An instruction builder represents a point within a basic block, and is the
781 * exclusive means of building instructions using the C interface.
782 */
783
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000784LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000785LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000786void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
787 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000788void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
789void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000790LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000791void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
792void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000793void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
794 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000795void LLVMDisposeBuilder(LLVMBuilderRef Builder);
796
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000797/* Metadata */
798void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
799LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
800void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
801
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000802/* Terminators */
803LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
804LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000805LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000806 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000807LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
808LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
809 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
810LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
811 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000812LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
813 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000814LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
815 LLVMValueRef *Args, unsigned NumArgs,
816 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
817 const char *Name);
818LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
819LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
820
Gordon Henriksen097102c2008-01-01 05:50:53 +0000821/* Add a case to the switch instruction */
822void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
823 LLVMBasicBlockRef Dest);
824
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000825/* Add a destination to the indirectbr instruction */
826void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
827
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000828/* Arithmetic */
829LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
830 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000831LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
832 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000833LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
834 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000835LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
836 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000837LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
838 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000839LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
840 const char *Name);
841LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
842 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000843LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
844 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000845LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
846 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000847LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
848 const char *Name);
849LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
850 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000851LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
852 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000853LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
854 const char *Name);
855LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
856 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000857LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
858 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000859LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
860 const char *Name);
861LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
862 const char *Name);
863LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
864 const char *Name);
865LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
866 const char *Name);
867LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
868 const char *Name);
869LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
870 const char *Name);
871LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
872 const char *Name);
873LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
874 const char *Name);
875LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
876 const char *Name);
877LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
878 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000879LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
880 LLVMValueRef LHS, LLVMValueRef RHS,
881 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000882LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000883LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
884 const char *Name);
885LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
886 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000887LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000888LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
889
890/* Memory */
891LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
892LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
893 LLVMValueRef Val, const char *Name);
894LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
895LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
896 LLVMValueRef Val, const char *Name);
897LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
898LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
899 const char *Name);
900LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
901LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
902 LLVMValueRef *Indices, unsigned NumIndices,
903 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000904LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
905 LLVMValueRef *Indices, unsigned NumIndices,
906 const char *Name);
907LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
908 unsigned Idx, const char *Name);
909LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
910 const char *Name);
911LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
912 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000913
914/* Casts */
915LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
916 LLVMTypeRef DestTy, const char *Name);
917LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
918 LLVMTypeRef DestTy, const char *Name);
919LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
920 LLVMTypeRef DestTy, const char *Name);
921LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
922 LLVMTypeRef DestTy, const char *Name);
923LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
924 LLVMTypeRef DestTy, const char *Name);
925LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
926 LLVMTypeRef DestTy, const char *Name);
927LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
928 LLVMTypeRef DestTy, const char *Name);
929LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
930 LLVMTypeRef DestTy, const char *Name);
931LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
932 LLVMTypeRef DestTy, const char *Name);
933LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
934 LLVMTypeRef DestTy, const char *Name);
935LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
936 LLVMTypeRef DestTy, const char *Name);
937LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
938 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000939LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
940 LLVMTypeRef DestTy, const char *Name);
941LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
942 LLVMTypeRef DestTy, const char *Name);
943LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
944 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000945LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
946 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000947LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
948 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000949LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000950 LLVMTypeRef DestTy, const char *Name);
951LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
952 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000953
954/* Comparisons */
955LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
956 LLVMValueRef LHS, LLVMValueRef RHS,
957 const char *Name);
958LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
959 LLVMValueRef LHS, LLVMValueRef RHS,
960 const char *Name);
961
962/* Miscellaneous instructions */
963LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
964LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
965 LLVMValueRef *Args, unsigned NumArgs,
966 const char *Name);
967LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
968 LLVMValueRef Then, LLVMValueRef Else,
969 const char *Name);
970LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
971 const char *Name);
972LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
973 LLVMValueRef Index, const char *Name);
974LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
975 LLVMValueRef EltVal, LLVMValueRef Index,
976 const char *Name);
977LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
978 LLVMValueRef V2, LLVMValueRef Mask,
979 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000980LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
981 unsigned Index, const char *Name);
982LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
983 LLVMValueRef EltVal, unsigned Index,
984 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000985
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000986LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
987 const char *Name);
988LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
989 const char *Name);
990LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
991 LLVMValueRef RHS, const char *Name);
992
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000993
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000994/*===-- Module providers --------------------------------------------------===*/
995
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000996/* Changes the type of M so it can be passed to FunctionPassManagers and the
997 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000998 */
999LLVMModuleProviderRef
1000LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1001
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001002/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001003 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001004void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001005
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001006
1007/*===-- Memory buffers ----------------------------------------------------===*/
1008
Chris Lattner25963c62010-01-09 22:27:07 +00001009LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1010 LLVMMemoryBufferRef *OutMemBuf,
1011 char **OutMessage);
1012LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1013 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001014void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1015
Gordon Henriksen878114b2008-03-16 04:20:44 +00001016
1017/*===-- Pass Managers -----------------------------------------------------===*/
1018
1019/** Constructs a new whole-module pass pipeline. This type of pipeline is
1020 suitable for link-time optimization and whole-module transformations.
1021 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001022LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001023
1024/** Constructs a new function-by-function pass pipeline over the module
1025 provider. It does not take ownership of the module provider. This type of
1026 pipeline is suitable for code generation and JIT compilation tasks.
1027 See llvm::FunctionPassManager::FunctionPassManager. */
1028LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1029
1030/** Initializes, executes on the provided module, and finalizes all of the
1031 passes scheduled in the pass manager. Returns 1 if any of the passes
1032 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001033LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001034
1035/** Initializes all of the function passes scheduled in the function pass
1036 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1037 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001038LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001039
1040/** Executes all of the function passes scheduled in the function pass manager
1041 on the provided function. Returns 1 if any of the passes modified the
1042 function, false otherwise.
1043 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001044LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001045
1046/** Finalizes all of the function passes scheduled in in the function pass
1047 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1048 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001049LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001050
1051/** Frees the memory of a pass pipeline. For function pipelines, does not free
1052 the module provider.
1053 See llvm::PassManagerBase::~PassManagerBase. */
1054void LLVMDisposePassManager(LLVMPassManagerRef PM);
1055
1056
Gordon Henriksen76a03742007-09-18 03:18:57 +00001057#ifdef __cplusplus
1058}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001059
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001060namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001061 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001062 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001063
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001064 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1065 inline ty *unwrap(ref P) { \
1066 return reinterpret_cast<ty*>(P); \
1067 } \
1068 \
1069 inline ref wrap(const ty *P) { \
1070 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1071 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001072
Gordon Henriksen878114b2008-03-16 04:20:44 +00001073 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1074 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1075 \
1076 template<typename T> \
1077 inline T *unwrap(ref P) { \
1078 return cast<T>(unwrap(P)); \
1079 }
1080
1081 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1082 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1083 \
1084 template<typename T> \
1085 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001086 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001087 assert(Q && "Invalid cast!"); \
1088 return Q; \
1089 }
1090
1091 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1092 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001093 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1094 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001095 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001096 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001097 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001098 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Chris Lattner40cf28d2009-10-12 04:01:02 +00001099 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseIteratorRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001100 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001101 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1102 * Module.
1103 */
1104 inline Module *unwrap(LLVMModuleProviderRef MP) {
1105 return reinterpret_cast<Module*>(MP);
1106 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001107
Gordon Henriksen878114b2008-03-16 04:20:44 +00001108 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1109 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001110 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001111
1112 /* Specialized opaque context conversions.
1113 */
1114 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1115 return reinterpret_cast<LLVMContext**>(Tys);
1116 }
1117
1118 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1119 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1120 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001121
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001122 /* Specialized opaque type conversions.
1123 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001124 inline Type **unwrap(LLVMTypeRef* Tys) {
1125 return reinterpret_cast<Type**>(Tys);
1126 }
1127
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001128 inline LLVMTypeRef *wrap(const Type **Tys) {
1129 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1130 }
1131
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001132 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001133 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001134 inline Value **unwrap(LLVMValueRef *Vals) {
1135 return reinterpret_cast<Value**>(Vals);
1136 }
1137
1138 template<typename T>
1139 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1140 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001141 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001142 cast<T>(*I);
1143 #endif
1144 return reinterpret_cast<T**>(Vals);
1145 }
1146
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001147 inline LLVMValueRef *wrap(const Value **Vals) {
1148 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1149 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001150}
1151
1152#endif /* !defined(__cplusplus) */
1153
1154#endif /* !defined(LLVM_C_CORE_H) */