blob: 8d4fca1981b680a2debc4adcf141c701f8a20b67 [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);
Erick Tryzelaara8053df2010-02-28 05:51:33 +0000554LLVMValueRef LLVMConstUnion(LLVMTypeRef Ty, LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000555
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000556/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000557LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000558LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000559LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
560LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000561LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
562LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000563LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000564LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
565LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000566LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000567LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000568LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000569LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000570LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
571LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000572LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000573LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000574LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
575LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000576LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000577LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
578LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000579LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000580LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
581LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
582LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
583LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
584LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
585LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
586LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
587LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
588 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
589LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
590 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
591LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
592LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
593LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
594LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
595 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000596LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
597 LLVMValueRef *ConstantIndices,
598 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000599LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
600LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
601LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
602LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
603LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
604LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
605LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
606LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
607LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
608LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
609LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
610LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000611LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
612 LLVMTypeRef ToType);
613LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
614 LLVMTypeRef ToType);
615LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
616 LLVMTypeRef ToType);
617LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
618 LLVMTypeRef ToType);
619LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000620 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000621LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000622LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
623 LLVMValueRef ConstantIfTrue,
624 LLVMValueRef ConstantIfFalse);
625LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
626 LLVMValueRef IndexConstant);
627LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
628 LLVMValueRef ElementValueConstant,
629 LLVMValueRef IndexConstant);
630LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
631 LLVMValueRef VectorBConstant,
632 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000633LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
634 unsigned NumIdx);
635LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
636 LLVMValueRef ElementValueConstant,
637 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000638LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000639 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000640 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000641
Gordon Henriksen76a03742007-09-18 03:18:57 +0000642/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000643LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000644LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000645LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
646void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
647const char *LLVMGetSection(LLVMValueRef Global);
648void LLVMSetSection(LLVMValueRef Global, const char *Section);
649LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
650void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
651unsigned LLVMGetAlignment(LLVMValueRef Global);
652void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
653
654/* Operations on global variables */
655LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000656LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000657LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
658LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
659LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
660LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000661void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000662LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
663void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000664LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
665void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
666LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
667void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000668
Chris Lattner3d1f5522008-12-17 21:39:50 +0000669/* Operations on aliases */
670LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
671 const char *Name);
672
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000673/* Operations on functions */
674LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
675 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000676LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000677LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
678LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
679LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
680LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000681void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000682unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
683unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
684void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000685const char *LLVMGetGC(LLVMValueRef Fn);
686void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000687void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000688LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000689void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000690
Gordon Henriksen265f7802008-03-19 01:11:35 +0000691/* Operations on parameters */
692unsigned LLVMCountParams(LLVMValueRef Fn);
693void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
694LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
695LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000696LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
697LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
698LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
699LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000700void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
701void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000702LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000703void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000704
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000705/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000706LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000707LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000708LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000709LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000710unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
711void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000712LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
713LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
714LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
715LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000716LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000717
718LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
719 LLVMValueRef Fn,
720 const char *Name);
721LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
722 LLVMBasicBlockRef BB,
723 const char *Name);
724
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000725LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
726LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
727 const char *Name);
728void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
729
Gordon Henriksen265f7802008-03-19 01:11:35 +0000730/* Operations on instructions */
731LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000732LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
733LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
734LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
735LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000736
Gordon Henriksen1158c532007-12-29 20:45:00 +0000737/* Operations on call sites */
738void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
739unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000740void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
741void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
742 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000743void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
744 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000745
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000746/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000747LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
748void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000749
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000750/* Operations on phi nodes */
751void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
752 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
753unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
754LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
755LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000756
757/*===-- Instruction builders ----------------------------------------------===*/
758
759/* An instruction builder represents a point within a basic block, and is the
760 * exclusive means of building instructions using the C interface.
761 */
762
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000763LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000764LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000765void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
766 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000767void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
768void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000769LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000770void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
771void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000772void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
773 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000774void LLVMDisposeBuilder(LLVMBuilderRef Builder);
775
776/* Terminators */
777LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
778LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000779LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000780 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000781LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
782LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
783 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
784LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
785 LLVMBasicBlockRef Else, unsigned NumCases);
786LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
787 LLVMValueRef *Args, unsigned NumArgs,
788 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
789 const char *Name);
790LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
791LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
792
Gordon Henriksen097102c2008-01-01 05:50:53 +0000793/* Add a case to the switch instruction */
794void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
795 LLVMBasicBlockRef Dest);
796
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000797/* Arithmetic */
798LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
799 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000800LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
801 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000802LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
803 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000804LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
805 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000806LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
807 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000808LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
809 const char *Name);
810LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
811 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000812LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
813 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000814LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
815 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000816LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
817 const char *Name);
818LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
819 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000820LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
821 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000822LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
823 const char *Name);
824LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
825 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000826LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
827 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000828LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
829 const char *Name);
830LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
831 const char *Name);
832LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
833 const char *Name);
834LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
835 const char *Name);
836LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
837 const char *Name);
838LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
839 const char *Name);
840LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
841 const char *Name);
842LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
843 const char *Name);
844LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
845 const char *Name);
846LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
847 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000848LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
849 LLVMValueRef LHS, LLVMValueRef RHS,
850 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000851LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000852LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
853 const char *Name);
854LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
855 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000856LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000857LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
858
859/* Memory */
860LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
861LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
862 LLVMValueRef Val, const char *Name);
863LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
864LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
865 LLVMValueRef Val, const char *Name);
866LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
867LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
868 const char *Name);
869LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
870LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
871 LLVMValueRef *Indices, unsigned NumIndices,
872 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000873LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
874 LLVMValueRef *Indices, unsigned NumIndices,
875 const char *Name);
876LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
877 unsigned Idx, const char *Name);
878LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
879 const char *Name);
880LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
881 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000882
883/* Casts */
884LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
885 LLVMTypeRef DestTy, const char *Name);
886LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
887 LLVMTypeRef DestTy, const char *Name);
888LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
889 LLVMTypeRef DestTy, const char *Name);
890LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
891 LLVMTypeRef DestTy, const char *Name);
892LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
893 LLVMTypeRef DestTy, const char *Name);
894LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
895 LLVMTypeRef DestTy, const char *Name);
896LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
897 LLVMTypeRef DestTy, const char *Name);
898LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
899 LLVMTypeRef DestTy, const char *Name);
900LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
901 LLVMTypeRef DestTy, const char *Name);
902LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
903 LLVMTypeRef DestTy, const char *Name);
904LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
905 LLVMTypeRef DestTy, const char *Name);
906LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
907 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000908LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
909 LLVMTypeRef DestTy, const char *Name);
910LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
911 LLVMTypeRef DestTy, const char *Name);
912LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
913 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000914LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
915 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000916LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
917 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000918LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000919 LLVMTypeRef DestTy, const char *Name);
920LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
921 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000922
923/* Comparisons */
924LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
925 LLVMValueRef LHS, LLVMValueRef RHS,
926 const char *Name);
927LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
928 LLVMValueRef LHS, LLVMValueRef RHS,
929 const char *Name);
930
931/* Miscellaneous instructions */
932LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
933LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
934 LLVMValueRef *Args, unsigned NumArgs,
935 const char *Name);
936LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
937 LLVMValueRef Then, LLVMValueRef Else,
938 const char *Name);
939LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
940 const char *Name);
941LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
942 LLVMValueRef Index, const char *Name);
943LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
944 LLVMValueRef EltVal, LLVMValueRef Index,
945 const char *Name);
946LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
947 LLVMValueRef V2, LLVMValueRef Mask,
948 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000949LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
950 unsigned Index, const char *Name);
951LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
952 LLVMValueRef EltVal, unsigned Index,
953 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000954
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000955LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
956 const char *Name);
957LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
958 const char *Name);
959LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
960 LLVMValueRef RHS, const char *Name);
961
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000962
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000963/*===-- Module providers --------------------------------------------------===*/
964
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000965/* Changes the type of M so it can be passed to FunctionPassManagers and the
966 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000967 */
968LLVMModuleProviderRef
969LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
970
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000971/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000972 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000973void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000974
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000975
976/*===-- Memory buffers ----------------------------------------------------===*/
977
Chris Lattner25963c62010-01-09 22:27:07 +0000978LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
979 LLVMMemoryBufferRef *OutMemBuf,
980 char **OutMessage);
981LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
982 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000983void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
984
Gordon Henriksen878114b2008-03-16 04:20:44 +0000985
986/*===-- Pass Managers -----------------------------------------------------===*/
987
988/** Constructs a new whole-module pass pipeline. This type of pipeline is
989 suitable for link-time optimization and whole-module transformations.
990 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000991LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +0000992
993/** Constructs a new function-by-function pass pipeline over the module
994 provider. It does not take ownership of the module provider. This type of
995 pipeline is suitable for code generation and JIT compilation tasks.
996 See llvm::FunctionPassManager::FunctionPassManager. */
997LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
998
999/** Initializes, executes on the provided module, and finalizes all of the
1000 passes scheduled in the pass manager. Returns 1 if any of the passes
1001 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001002LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001003
1004/** Initializes all of the function passes scheduled in the function pass
1005 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1006 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001007LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001008
1009/** Executes all of the function passes scheduled in the function pass manager
1010 on the provided function. Returns 1 if any of the passes modified the
1011 function, false otherwise.
1012 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001013LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001014
1015/** Finalizes all of the function passes scheduled in in the function pass
1016 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1017 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001018LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001019
1020/** Frees the memory of a pass pipeline. For function pipelines, does not free
1021 the module provider.
1022 See llvm::PassManagerBase::~PassManagerBase. */
1023void LLVMDisposePassManager(LLVMPassManagerRef PM);
1024
1025
Gordon Henriksen76a03742007-09-18 03:18:57 +00001026#ifdef __cplusplus
1027}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001028
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001029namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001030 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001031 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001032
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001033 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1034 inline ty *unwrap(ref P) { \
1035 return reinterpret_cast<ty*>(P); \
1036 } \
1037 \
1038 inline ref wrap(const ty *P) { \
1039 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1040 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001041
Gordon Henriksen878114b2008-03-16 04:20:44 +00001042 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1043 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1044 \
1045 template<typename T> \
1046 inline T *unwrap(ref P) { \
1047 return cast<T>(unwrap(P)); \
1048 }
1049
1050 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1051 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1052 \
1053 template<typename T> \
1054 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001055 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001056 assert(Q && "Invalid cast!"); \
1057 return Q; \
1058 }
1059
1060 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1061 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001062 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1063 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001064 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001065 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001066 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001067 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Chris Lattner40cf28d2009-10-12 04:01:02 +00001068 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseIteratorRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001069 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001070 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1071 * Module.
1072 */
1073 inline Module *unwrap(LLVMModuleProviderRef MP) {
1074 return reinterpret_cast<Module*>(MP);
1075 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001076
Gordon Henriksen878114b2008-03-16 04:20:44 +00001077 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1078 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001079 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001080
1081 /* Specialized opaque context conversions.
1082 */
1083 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1084 return reinterpret_cast<LLVMContext**>(Tys);
1085 }
1086
1087 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1088 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1089 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001090
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001091 /* Specialized opaque type conversions.
1092 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001093 inline Type **unwrap(LLVMTypeRef* Tys) {
1094 return reinterpret_cast<Type**>(Tys);
1095 }
1096
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001097 inline LLVMTypeRef *wrap(const Type **Tys) {
1098 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1099 }
1100
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001101 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001102 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001103 inline Value **unwrap(LLVMValueRef *Vals) {
1104 return reinterpret_cast<Value**>(Vals);
1105 }
1106
1107 template<typename T>
1108 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1109 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001110 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001111 cast<T>(*I);
1112 #endif
1113 return reinterpret_cast<T**>(Vals);
1114 }
1115
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001116 inline LLVMValueRef *wrap(const Value **Vals) {
1117 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1118 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001119}
1120
1121#endif /* !defined(__cplusplus) */
1122
1123#endif /* !defined(LLVM_C_CORE_H) */