blob: d665c89377f43b8466ff1beeb6e4bdd8a4707099 [file] [log] [blame]
Gordon Henriksen76a03742007-09-18 03:18:57 +00001/*===-- llvm-c/Core.h - Core Library C Interface ------------------*- C -*-===*\
2|* *|
3|* The LLVM Compiler Infrastructure *|
4|* *|
Chris Lattnere9cc7422007-12-29 19:59:42 +00005|* This file is distributed under the University of Illinois Open Source *|
6|* License. See LICENSE.TXT for details. *|
Gordon Henriksen76a03742007-09-18 03:18:57 +00007|* *|
8|*===----------------------------------------------------------------------===*|
9|* *|
10|* This header declares the C interface to libLLVMCore.a, which implements *|
11|* the LLVM intermediate representation. *|
12|* *|
13|* LLVM uses a polymorphic type hierarchy which C cannot represent, therefore *|
14|* parameters must be passed as base types. Despite the declared types, most *|
15|* of the functions provided operate only on branches of the type hierarchy. *|
16|* The declared parameter names are descriptive and specify which type is *|
17|* required. Additionally, each type hierarchy is documented along with the *|
18|* functions that operate upon it. For more detail, refer to LLVM's C++ code. *|
19|* If in doubt, refer to Core.cpp, which performs paramter downcasts in the *|
20|* form unwrap<RequiredType>(Param). *|
21|* *|
22|* Many exotic languages can interoperate with C code but have a harder time *|
23|* with C++ due to name mangling. So in addition to C, this interface enables *|
24|* tools written in such languages. *|
25|* *|
Gordon Henriksen7330acd2007-10-05 23:59:36 +000026|* When included into a C++ source file, also declares 'wrap' and 'unwrap' *|
27|* helpers to perform opaque reference<-->pointer conversions. These helpers *|
28|* are shorter and more tightly typed than writing the casts by hand when *|
29|* authoring bindings. In assert builds, they will do runtime type checking. *|
30|* *|
Gordon Henriksen76a03742007-09-18 03:18:57 +000031\*===----------------------------------------------------------------------===*/
32
33#ifndef LLVM_C_CORE_H
34#define LLVM_C_CORE_H
35
Chandler Carruth56869f22009-10-26 01:35:46 +000036#include "llvm/System/DataTypes.h"
Erick Tryzelaardd991352009-08-16 23:36:46 +000037
Gordon Henriksen76a03742007-09-18 03:18:57 +000038#ifdef __cplusplus
Gordon Henriksen7330acd2007-10-05 23:59:36 +000039
40/* Need these includes to support the LLVM 'cast' template for the C++ 'wrap'
41 and 'unwrap' conversion functions. */
42#include "llvm/Module.h"
Duncan Sandsa07136e2008-04-13 06:22:09 +000043#include "llvm/Support/IRBuilder.h"
Gordon Henriksen7330acd2007-10-05 23:59:36 +000044
Gordon Henriksen76a03742007-09-18 03:18:57 +000045extern "C" {
46#endif
47
48
Chris Lattner25963c62010-01-09 22:27:07 +000049typedef int LLVMBool;
50
Gordon Henriksen76a03742007-09-18 03:18:57 +000051/* Opaque types. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000052
53/**
Owen Anderson6773d382009-07-01 16:58:40 +000054 * The top-level container for all LLVM global data. See the LLVMContext class.
55 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +000056typedef struct LLVMOpaqueContext *LLVMContextRef;
Owen Anderson6773d382009-07-01 16:58:40 +000057
58/**
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000059 * The top-level container for all other LLVM Intermediate Representation (IR)
60 * objects. See the llvm::Module class.
61 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000062typedef struct LLVMOpaqueModule *LLVMModuleRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000063
64/**
Gordon Henriksena49d4352008-03-07 19:13:06 +000065 * Each value in the LLVM IR has a type, an LLVMTypeRef. See the llvm::Type
66 * class.
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000067 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000068typedef struct LLVMOpaqueType *LLVMTypeRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000069
70/**
Gordon Henriksena49d4352008-03-07 19:13:06 +000071 * When building recursive types using LLVMRefineType, LLVMTypeRef values may
72 * become invalid; use LLVMTypeHandleRef to resolve this problem. See the
73 * llvm::AbstractTypeHolder class.
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000074 */
Gordon Henriksenffb48762007-10-07 00:13:35 +000075typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000076
Gordon Henriksen76a03742007-09-18 03:18:57 +000077typedef struct LLVMOpaqueValue *LLVMValueRef;
Gordon Henriksenc23b66c2007-09-26 20:56:12 +000078typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
79typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000080
Jeffrey Yasskin091217b2010-01-27 20:34:15 +000081/* Interface used to provide a module to JIT or interpreter. This is now just a
82 * synonym for llvm::Module, but we have to keep using the different type to
83 * keep binary compatibility.
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000084 */
Gordon Henriksen0a68fe22007-12-12 01:04:30 +000085typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
Gordon Henriksen76a03742007-09-18 03:18:57 +000086
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000087/* Used to provide a module to JIT or interpreter.
88 * See the llvm::MemoryBuffer class.
89 */
90typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
91
Gordon Henriksen878114b2008-03-16 04:20:44 +000092/** See the llvm::PassManagerBase class. */
93typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
94
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +000095/** Used to get the users and usees of a Value. See the llvm::Use class. */
96typedef struct LLVMOpaqueUse *LLVMUseRef;
Chris Lattner40cf28d2009-10-12 04:01:02 +000097
Gordon Henriksen76a03742007-09-18 03:18:57 +000098typedef enum {
Devang Patel4c758ea2008-09-25 21:00:45 +000099 LLVMZExtAttribute = 1<<0,
100 LLVMSExtAttribute = 1<<1,
101 LLVMNoReturnAttribute = 1<<2,
102 LLVMInRegAttribute = 1<<3,
103 LLVMStructRetAttribute = 1<<4,
104 LLVMNoUnwindAttribute = 1<<5,
105 LLVMNoAliasAttribute = 1<<6,
106 LLVMByValAttribute = 1<<7,
107 LLVMNestAttribute = 1<<8,
108 LLVMReadNoneAttribute = 1<<9,
Anton Korobeynikovc8ce7b082009-07-17 18:07:26 +0000109 LLVMReadOnlyAttribute = 1<<10,
Anton Korobeynikov9750be92009-07-17 18:57:16 +0000110 LLVMNoInlineAttribute = 1<<11,
111 LLVMAlwaysInlineAttribute = 1<<12,
112 LLVMOptimizeForSizeAttribute = 1<<13,
113 LLVMStackProtectAttribute = 1<<14,
114 LLVMStackProtectReqAttribute = 1<<15,
Erick Tryzelaar8f69fea2010-03-03 23:51:25 +0000115 LLVMAlignment = 31<<16,
Anton Korobeynikov9750be92009-07-17 18:57:16 +0000116 LLVMNoCaptureAttribute = 1<<21,
117 LLVMNoRedZoneAttribute = 1<<22,
118 LLVMNoImplicitFloatAttribute = 1<<23,
Jakob Stoklund Olesen74bb06c2010-02-06 01:16:28 +0000119 LLVMNakedAttribute = 1<<24,
Erick Tryzelaar8f69fea2010-03-03 23:51:25 +0000120 LLVMInlineHintAttribute = 1<<25,
121 LLVMStackAlignment = 7<<26
Devang Patel4c758ea2008-09-25 21:00:45 +0000122} LLVMAttribute;
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000123
124typedef enum {
Bill Wendlingda52cec2010-02-15 20:53:17 +0000125 /* Terminator Instructions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000126 LLVMRet = 1,
127 LLVMBr = 2,
128 LLVMSwitch = 3,
Bill Wendling07d6d762010-02-15 20:50:51 +0000129 LLVMIndirectBr = 4,
130 LLVMInvoke = 5,
131 LLVMUnwind = 6,
132 LLVMUnreachable = 7,
133
Bill Wendlingda52cec2010-02-15 20:53:17 +0000134 /* Standard Binary Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000135 LLVMAdd = 8,
136 LLVMFAdd = 9,
137 LLVMSub = 10,
138 LLVMFSub = 11,
139 LLVMMul = 12,
140 LLVMFMul = 13,
141 LLVMUDiv = 14,
142 LLVMSDiv = 15,
143 LLVMFDiv = 16,
144 LLVMURem = 17,
145 LLVMSRem = 18,
146 LLVMFRem = 19,
147
Bill Wendlingda52cec2010-02-15 20:53:17 +0000148 /* Logical Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000149 LLVMShl = 20,
150 LLVMLShr = 21,
151 LLVMAShr = 22,
152 LLVMAnd = 23,
153 LLVMOr = 24,
154 LLVMXor = 25,
155
Bill Wendlingda52cec2010-02-15 20:53:17 +0000156 /* Memory Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000157 LLVMAlloca = 26,
158 LLVMLoad = 27,
159 LLVMStore = 28,
160 LLVMGetElementPtr = 29,
161
Bill Wendlingda52cec2010-02-15 20:53:17 +0000162 /* Cast Operators */
Erick Tryzelaar5bf1a322010-02-16 03:45:23 +0000163 LLVMTrunc = 30,
Bill Wendling07d6d762010-02-15 20:50:51 +0000164 LLVMZExt = 31,
165 LLVMSExt = 32,
166 LLVMFPToUI = 33,
167 LLVMFPToSI = 34,
168 LLVMUIToFP = 35,
169 LLVMSIToFP = 36,
170 LLVMFPTrunc = 37,
171 LLVMFPExt = 38,
172 LLVMPtrToInt = 39,
173 LLVMIntToPtr = 40,
174 LLVMBitCast = 41,
175
Bill Wendlingda52cec2010-02-15 20:53:17 +0000176 /* Other Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000177 LLVMICmp = 42,
178 LLVMFCmp = 43,
179 LLVMPHI = 44,
180 LLVMCall = 45,
181 LLVMSelect = 46,
Bill Wendlingda52cec2010-02-15 20:53:17 +0000182 /* UserOp1 */
183 /* UserOp2 */
Bill Wendling07d6d762010-02-15 20:50:51 +0000184 LLVMVAArg = 49,
185 LLVMExtractElement = 50,
186 LLVMInsertElement = 51,
187 LLVMShuffleVector = 52,
188 LLVMExtractValue = 53,
189 LLVMInsertValue = 54
Chris Lattner40cf28d2009-10-12 04:01:02 +0000190} LLVMOpcode;
191
192typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000193 LLVMVoidTypeKind, /**< type with no size */
194 LLVMFloatTypeKind, /**< 32 bit floating point type */
195 LLVMDoubleTypeKind, /**< 64 bit floating point type */
196 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
197 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
198 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
199 LLVMLabelTypeKind, /**< Labels */
200 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
201 LLVMFunctionTypeKind, /**< Functions */
202 LLVMStructTypeKind, /**< Structures */
203 LLVMArrayTypeKind, /**< Arrays */
204 LLVMPointerTypeKind, /**< Pointers */
205 LLVMOpaqueTypeKind, /**< Opaque: type with unknown structure */
Chris Lattnerdac44ec2009-07-15 22:00:31 +0000206 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
Chris Lattner392be582010-02-12 20:49:41 +0000207 LLVMMetadataTypeKind, /**< Metadata */
208 LLVMUnionTypeKind /**< Unions */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000209} LLVMTypeKind;
210
211typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000212 LLVMExternalLinkage, /**< Externally visible function */
Chris Lattner2dba0f02009-04-13 06:25:37 +0000213 LLVMAvailableExternallyLinkage,
Duncan Sands12da8ce2009-03-07 15:45:40 +0000214 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
215 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
216 equivalent. */
217 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
218 LLVMWeakODRLinkage, /**< Same, but only replaced by something
219 equivalent. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000220 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
221 LLVMInternalLinkage, /**< Rename collisions when linking (static
222 functions) */
Duncan Sands12da8ce2009-03-07 15:45:40 +0000223 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000224 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
225 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
Duncan Sandse2881052009-03-11 08:08:06 +0000226 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000227 LLVMGhostLinkage, /**< Obsolete */
Bill Wendling002b1672009-07-20 18:22:52 +0000228 LLVMCommonLinkage, /**< Tentative definitions */
Bill Wendling36321712010-06-29 22:34:52 +0000229 LLVMLinkerPrivateLinkage /**< Like Private, but linker removes. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000230} LLVMLinkage;
231
232typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000233 LLVMDefaultVisibility, /**< The GV is visible */
234 LLVMHiddenVisibility, /**< The GV is hidden */
235 LLVMProtectedVisibility /**< The GV is protected */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000236} LLVMVisibility;
237
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000238typedef enum {
239 LLVMCCallConv = 0,
240 LLVMFastCallConv = 8,
241 LLVMColdCallConv = 9,
242 LLVMX86StdcallCallConv = 64,
243 LLVMX86FastcallCallConv = 65
244} LLVMCallConv;
245
246typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000247 LLVMIntEQ = 32, /**< equal */
248 LLVMIntNE, /**< not equal */
249 LLVMIntUGT, /**< unsigned greater than */
250 LLVMIntUGE, /**< unsigned greater or equal */
251 LLVMIntULT, /**< unsigned less than */
252 LLVMIntULE, /**< unsigned less or equal */
253 LLVMIntSGT, /**< signed greater than */
254 LLVMIntSGE, /**< signed greater or equal */
255 LLVMIntSLT, /**< signed less than */
256 LLVMIntSLE /**< signed less or equal */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000257} LLVMIntPredicate;
258
259typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000260 LLVMRealPredicateFalse, /**< Always false (always folded) */
261 LLVMRealOEQ, /**< True if ordered and equal */
262 LLVMRealOGT, /**< True if ordered and greater than */
263 LLVMRealOGE, /**< True if ordered and greater than or equal */
264 LLVMRealOLT, /**< True if ordered and less than */
265 LLVMRealOLE, /**< True if ordered and less than or equal */
266 LLVMRealONE, /**< True if ordered and operands are unequal */
267 LLVMRealORD, /**< True if ordered (no nans) */
268 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
269 LLVMRealUEQ, /**< True if unordered or equal */
270 LLVMRealUGT, /**< True if unordered or greater than */
271 LLVMRealUGE, /**< True if unordered, greater than, or equal */
272 LLVMRealULT, /**< True if unordered or less than */
273 LLVMRealULE, /**< True if unordered, less than, or equal */
274 LLVMRealUNE, /**< True if unordered or not equal */
275 LLVMRealPredicateTrue /**< Always true (always folded) */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000276} LLVMRealPredicate;
277
Gordon Henriksen76a03742007-09-18 03:18:57 +0000278
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000279/*===-- Error handling ----------------------------------------------------===*/
280
281void LLVMDisposeMessage(char *Message);
282
283
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000284/*===-- Contexts ----------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000285
Owen Anderson6773d382009-07-01 16:58:40 +0000286/* Create and destroy contexts. */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000287LLVMContextRef LLVMContextCreate(void);
288LLVMContextRef LLVMGetGlobalContext(void);
Owen Anderson6773d382009-07-01 16:58:40 +0000289void LLVMContextDispose(LLVMContextRef C);
290
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000291unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
292 unsigned SLen);
293unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
294
295/*===-- Modules -----------------------------------------------------------===*/
296
Gordon Henriksen76a03742007-09-18 03:18:57 +0000297/* Create and destroy modules. */
Gordon Henriksena49d4352008-03-07 19:13:06 +0000298/** See llvm::Module::Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000299LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Owen Anderson31d44e42009-07-02 07:17:57 +0000300LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
301 LLVMContextRef C);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000302
303/** See llvm::Module::~Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000304void LLVMDisposeModule(LLVMModuleRef M);
305
Gordon Henriksena49d4352008-03-07 19:13:06 +0000306/** Data layout. See Module::getDataLayout. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000307const char *LLVMGetDataLayout(LLVMModuleRef M);
308void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
309
Gordon Henriksena49d4352008-03-07 19:13:06 +0000310/** Target triple. See Module::getTargetTriple. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000311const char *LLVMGetTarget(LLVMModuleRef M);
312void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
313
Gordon Henriksena49d4352008-03-07 19:13:06 +0000314/** See Module::addTypeName. */
Chris Lattner25963c62010-01-09 22:27:07 +0000315LLVMBool LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000316void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
Chris Lattner7f318242009-07-06 17:29:59 +0000317LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000318
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000319/** See Module::dump. */
320void LLVMDumpModule(LLVMModuleRef M);
321
Chris Lattner26941452010-04-10 17:52:58 +0000322/** See Module::setModuleInlineAsm. */
323void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000324
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000325/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000326
327/* LLVM types conform to the following hierarchy:
328 *
329 * types:
330 * integer type
331 * real type
332 * function type
333 * sequence types:
334 * array type
335 * pointer type
336 * vector type
337 * void type
338 * label type
339 * opaque type
340 */
341
Gordon Henriksena49d4352008-03-07 19:13:06 +0000342/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000343LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000344
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000345/** See llvm::LLVMType::getContext. */
346LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
347
Gordon Henriksen76a03742007-09-18 03:18:57 +0000348/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000349LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
350LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
351LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
352LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
353LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
354LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
355
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000356LLVMTypeRef LLVMInt1Type(void);
357LLVMTypeRef LLVMInt8Type(void);
358LLVMTypeRef LLVMInt16Type(void);
359LLVMTypeRef LLVMInt32Type(void);
360LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000361LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000362unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000363
364/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000365LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
366LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
367LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
368LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
369LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
370
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000371LLVMTypeRef LLVMFloatType(void);
372LLVMTypeRef LLVMDoubleType(void);
373LLVMTypeRef LLVMX86FP80Type(void);
374LLVMTypeRef LLVMFP128Type(void);
375LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000376
377/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000378LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
379 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000380 LLVMBool IsVarArg);
381LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000382LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
383unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
384void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000385
386/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000387LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000388 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000389LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000390 LLVMBool Packed);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000391unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000392void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000393LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000394
Chris Lattner392be582010-02-12 20:49:41 +0000395/* Operations on union types */
396LLVMTypeRef LLVMUnionTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
397 unsigned ElementCount);
398LLVMTypeRef LLVMUnionType(LLVMTypeRef *ElementTypes, unsigned ElementCount);
399unsigned LLVMCountUnionElementTypes(LLVMTypeRef UnionTy);
400void LLVMGetUnionElementTypes(LLVMTypeRef UnionTy, LLVMTypeRef *Dest);
401
Gordon Henriksen76a03742007-09-18 03:18:57 +0000402/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000403LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000404LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000405LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000406
407LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
408unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000409unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000410unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
411
412/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000413LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
414LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
415LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
416
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000417LLVMTypeRef LLVMVoidType(void);
418LLVMTypeRef LLVMLabelType(void);
419LLVMTypeRef LLVMOpaqueType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000420
Gordon Henriksenffb48762007-10-07 00:13:35 +0000421/* Operations on type handles */
422LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
423void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
424LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
425void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
426
Gordon Henriksen76a03742007-09-18 03:18:57 +0000427
428/*===-- Values ------------------------------------------------------------===*/
429
430/* The bulk of LLVM's object model consists of values, which comprise a very
431 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000432 */
433
Gordon Henriksen29e38942008-12-19 18:39:45 +0000434#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
435 macro(Argument) \
436 macro(BasicBlock) \
437 macro(InlineAsm) \
438 macro(User) \
439 macro(Constant) \
440 macro(ConstantAggregateZero) \
441 macro(ConstantArray) \
442 macro(ConstantExpr) \
443 macro(ConstantFP) \
444 macro(ConstantInt) \
445 macro(ConstantPointerNull) \
446 macro(ConstantStruct) \
447 macro(ConstantVector) \
448 macro(GlobalValue) \
449 macro(Function) \
450 macro(GlobalAlias) \
451 macro(GlobalVariable) \
452 macro(UndefValue) \
453 macro(Instruction) \
454 macro(BinaryOperator) \
455 macro(CallInst) \
456 macro(IntrinsicInst) \
457 macro(DbgInfoIntrinsic) \
458 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000459 macro(EHSelectorInst) \
460 macro(MemIntrinsic) \
461 macro(MemCpyInst) \
462 macro(MemMoveInst) \
463 macro(MemSetInst) \
464 macro(CmpInst) \
465 macro(FCmpInst) \
466 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000467 macro(ExtractElementInst) \
468 macro(GetElementPtrInst) \
469 macro(InsertElementInst) \
470 macro(InsertValueInst) \
471 macro(PHINode) \
472 macro(SelectInst) \
473 macro(ShuffleVectorInst) \
474 macro(StoreInst) \
475 macro(TerminatorInst) \
476 macro(BranchInst) \
477 macro(InvokeInst) \
478 macro(ReturnInst) \
479 macro(SwitchInst) \
480 macro(UnreachableInst) \
481 macro(UnwindInst) \
482 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000483 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000484 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000485 macro(BitCastInst) \
486 macro(FPExtInst) \
487 macro(FPToSIInst) \
488 macro(FPToUIInst) \
489 macro(FPTruncInst) \
490 macro(IntToPtrInst) \
491 macro(PtrToIntInst) \
492 macro(SExtInst) \
493 macro(SIToFPInst) \
494 macro(TruncInst) \
495 macro(UIToFPInst) \
496 macro(ZExtInst) \
497 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000498 macro(LoadInst) \
499 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000500
Gordon Henriksen76a03742007-09-18 03:18:57 +0000501/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000502LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000503const char *LLVMGetValueName(LLVMValueRef Val);
504void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000505void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000506void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000507int LLVMHasMetadata(LLVMValueRef Val);
508LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
509void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000510
Gordon Henriksen29e38942008-12-19 18:39:45 +0000511/* Conversion functions. Return the input value if it is an instance of the
512 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
513#define LLVM_DECLARE_VALUE_CAST(name) \
514 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
515LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
516
Chris Lattner40cf28d2009-10-12 04:01:02 +0000517/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000518LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
519LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
520LLVMValueRef LLVMGetUser(LLVMUseRef U);
521LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000522
523/* Operations on Users */
524LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
525
Gordon Henriksen76a03742007-09-18 03:18:57 +0000526/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000527LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
528LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000529LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000530LLVMBool LLVMIsConstant(LLVMValueRef Val);
531LLVMBool LLVMIsNull(LLVMValueRef Val);
532LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000533LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000534
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000535/* Operations on metadata */
536LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
537 unsigned SLen);
538LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
539LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
540 unsigned Count);
541LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
542
Gordon Henriksen76a03742007-09-18 03:18:57 +0000543/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000544LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000545 LLVMBool SignExtend);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000546LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
547 uint8_t Radix);
548LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
549 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000550LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000551LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000552LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
553 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000554unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
555long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000556
Gordon Henriksen76a03742007-09-18 03:18:57 +0000557
558/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000559LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000560 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000561LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
562 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000563 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000564
Gordon Henriksen1046c732007-10-06 15:11:06 +0000565LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000566 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000567LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000568 LLVMValueRef *ConstantVals, unsigned Length);
569LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000570 LLVMBool Packed);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000571LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Erick Tryzelaara8053df2010-02-28 05:51:33 +0000572LLVMValueRef LLVMConstUnion(LLVMTypeRef Ty, LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000573
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000574/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000575LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000576LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000577LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
578LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000579LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
580LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000581LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000582LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
583LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000584LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000585LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000586LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000587LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000588LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
589LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000590LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000591LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000592LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
593LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000594LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000595LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
596LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000597LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000598LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
599LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
600LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
601LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
602LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
604LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
605LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
606 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
607LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
608 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
609LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
611LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
612LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
613 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000614LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
615 LLVMValueRef *ConstantIndices,
616 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000617LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
618LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
619LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
620LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
621LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
622LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
623LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
624LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
625LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
626LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
627LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
628LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000629LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
630 LLVMTypeRef ToType);
631LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
632 LLVMTypeRef ToType);
633LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
634 LLVMTypeRef ToType);
635LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
636 LLVMTypeRef ToType);
637LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000638 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000639LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000640LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
641 LLVMValueRef ConstantIfTrue,
642 LLVMValueRef ConstantIfFalse);
643LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
644 LLVMValueRef IndexConstant);
645LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
646 LLVMValueRef ElementValueConstant,
647 LLVMValueRef IndexConstant);
648LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
649 LLVMValueRef VectorBConstant,
650 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000651LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
652 unsigned NumIdx);
653LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
654 LLVMValueRef ElementValueConstant,
655 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000656LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000657 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000658 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000659LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000660
Gordon Henriksen76a03742007-09-18 03:18:57 +0000661/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000662LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000663LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000664LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
665void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
666const char *LLVMGetSection(LLVMValueRef Global);
667void LLVMSetSection(LLVMValueRef Global, const char *Section);
668LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
669void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
670unsigned LLVMGetAlignment(LLVMValueRef Global);
671void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
672
673/* Operations on global variables */
674LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000675LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
676 const char *Name,
677 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000678LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000679LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
680LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
681LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
682LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000683void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000684LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
685void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000686LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
687void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
688LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
689void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000690
Chris Lattner3d1f5522008-12-17 21:39:50 +0000691/* Operations on aliases */
692LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
693 const char *Name);
694
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000695/* Operations on functions */
696LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
697 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000698LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000699LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
700LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
701LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
702LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000703void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000704unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
705unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
706void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000707const char *LLVMGetGC(LLVMValueRef Fn);
708void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000709void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000710LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000711void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000712
Gordon Henriksen265f7802008-03-19 01:11:35 +0000713/* Operations on parameters */
714unsigned LLVMCountParams(LLVMValueRef Fn);
715void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
716LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
717LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000718LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
719LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
720LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
721LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000722void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
723void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000724LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000725void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000726
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000727/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000728LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000729LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000730LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000731LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000732unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
733void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000734LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
735LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
736LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
737LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000738LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000739
740LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
741 LLVMValueRef Fn,
742 const char *Name);
743LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
744 LLVMBasicBlockRef BB,
745 const char *Name);
746
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000747LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
748LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
749 const char *Name);
750void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
751
Gordon Henriksen265f7802008-03-19 01:11:35 +0000752/* Operations on instructions */
753LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000754LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
755LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
756LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
757LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000758
Gordon Henriksen1158c532007-12-29 20:45:00 +0000759/* Operations on call sites */
760void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
761unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000762void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
763void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
764 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000765void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
766 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000767
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000768/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000769LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
770void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000771
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000772/* Operations on phi nodes */
773void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
774 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
775unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
776LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
777LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000778
779/*===-- Instruction builders ----------------------------------------------===*/
780
781/* An instruction builder represents a point within a basic block, and is the
782 * exclusive means of building instructions using the C interface.
783 */
784
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000785LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000786LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000787void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
788 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000789void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
790void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000791LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000792void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
793void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000794void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
795 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000796void LLVMDisposeBuilder(LLVMBuilderRef Builder);
797
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000798/* Metadata */
799void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
800LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
801void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
802
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000803/* Terminators */
804LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
805LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000806LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000807 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000808LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
809LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
810 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
811LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
812 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000813LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
814 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000815LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
816 LLVMValueRef *Args, unsigned NumArgs,
817 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
818 const char *Name);
819LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
820LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
821
Gordon Henriksen097102c2008-01-01 05:50:53 +0000822/* Add a case to the switch instruction */
823void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
824 LLVMBasicBlockRef Dest);
825
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000826/* Add a destination to the indirectbr instruction */
827void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
828
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000829/* Arithmetic */
830LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
831 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000832LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
833 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000834LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
835 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000836LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
837 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000838LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
839 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000840LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
841 const char *Name);
842LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
843 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000844LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
845 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000846LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
847 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000848LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
849 const char *Name);
850LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
851 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000852LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
853 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000854LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
855 const char *Name);
856LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
857 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000858LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
859 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000860LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
861 const char *Name);
862LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
863 const char *Name);
864LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
865 const char *Name);
866LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
867 const char *Name);
868LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
869 const char *Name);
870LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
871 const char *Name);
872LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
873 const char *Name);
874LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
875 const char *Name);
876LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
877 const char *Name);
878LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
879 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000880LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
881 LLVMValueRef LHS, LLVMValueRef RHS,
882 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000883LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000884LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
885 const char *Name);
886LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
887 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000888LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000889LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
890
891/* Memory */
892LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
893LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
894 LLVMValueRef Val, const char *Name);
895LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
896LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
897 LLVMValueRef Val, const char *Name);
898LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
899LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
900 const char *Name);
901LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
902LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
903 LLVMValueRef *Indices, unsigned NumIndices,
904 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000905LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
906 LLVMValueRef *Indices, unsigned NumIndices,
907 const char *Name);
908LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
909 unsigned Idx, const char *Name);
910LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
911 const char *Name);
912LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
913 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000914
915/* Casts */
916LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
917 LLVMTypeRef DestTy, const char *Name);
918LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
919 LLVMTypeRef DestTy, const char *Name);
920LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
921 LLVMTypeRef DestTy, const char *Name);
922LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
923 LLVMTypeRef DestTy, const char *Name);
924LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
925 LLVMTypeRef DestTy, const char *Name);
926LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
927 LLVMTypeRef DestTy, const char *Name);
928LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
929 LLVMTypeRef DestTy, const char *Name);
930LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
931 LLVMTypeRef DestTy, const char *Name);
932LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
933 LLVMTypeRef DestTy, const char *Name);
934LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
935 LLVMTypeRef DestTy, const char *Name);
936LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
937 LLVMTypeRef DestTy, const char *Name);
938LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
939 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000940LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
941 LLVMTypeRef DestTy, const char *Name);
942LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
943 LLVMTypeRef DestTy, const char *Name);
944LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
945 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000946LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
947 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000948LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
949 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000950LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000951 LLVMTypeRef DestTy, const char *Name);
952LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
953 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000954
955/* Comparisons */
956LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
957 LLVMValueRef LHS, LLVMValueRef RHS,
958 const char *Name);
959LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
960 LLVMValueRef LHS, LLVMValueRef RHS,
961 const char *Name);
962
963/* Miscellaneous instructions */
964LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
965LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
966 LLVMValueRef *Args, unsigned NumArgs,
967 const char *Name);
968LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
969 LLVMValueRef Then, LLVMValueRef Else,
970 const char *Name);
971LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
972 const char *Name);
973LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
974 LLVMValueRef Index, const char *Name);
975LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
976 LLVMValueRef EltVal, LLVMValueRef Index,
977 const char *Name);
978LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
979 LLVMValueRef V2, LLVMValueRef Mask,
980 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000981LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
982 unsigned Index, const char *Name);
983LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
984 LLVMValueRef EltVal, unsigned Index,
985 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000986
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000987LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
988 const char *Name);
989LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
990 const char *Name);
991LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
992 LLVMValueRef RHS, const char *Name);
993
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000994
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000995/*===-- Module providers --------------------------------------------------===*/
996
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000997/* Changes the type of M so it can be passed to FunctionPassManagers and the
998 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000999 */
1000LLVMModuleProviderRef
1001LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1002
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001003/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001004 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001005void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001006
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001007
1008/*===-- Memory buffers ----------------------------------------------------===*/
1009
Chris Lattner25963c62010-01-09 22:27:07 +00001010LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1011 LLVMMemoryBufferRef *OutMemBuf,
1012 char **OutMessage);
1013LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1014 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001015void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1016
Gordon Henriksen878114b2008-03-16 04:20:44 +00001017
1018/*===-- Pass Managers -----------------------------------------------------===*/
1019
1020/** Constructs a new whole-module pass pipeline. This type of pipeline is
1021 suitable for link-time optimization and whole-module transformations.
1022 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001023LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001024
1025/** Constructs a new function-by-function pass pipeline over the module
1026 provider. It does not take ownership of the module provider. This type of
1027 pipeline is suitable for code generation and JIT compilation tasks.
1028 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001029LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1030
1031/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001032LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1033
1034/** Initializes, executes on the provided module, and finalizes all of the
1035 passes scheduled in the pass manager. Returns 1 if any of the passes
1036 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001037LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001038
1039/** Initializes all of the function passes scheduled in the function pass
1040 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1041 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001042LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001043
1044/** Executes all of the function passes scheduled in the function pass manager
1045 on the provided function. Returns 1 if any of the passes modified the
1046 function, false otherwise.
1047 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001048LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001049
1050/** Finalizes all of the function passes scheduled in in the function pass
1051 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1052 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001053LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001054
1055/** Frees the memory of a pass pipeline. For function pipelines, does not free
1056 the module provider.
1057 See llvm::PassManagerBase::~PassManagerBase. */
1058void LLVMDisposePassManager(LLVMPassManagerRef PM);
1059
1060
Gordon Henriksen76a03742007-09-18 03:18:57 +00001061#ifdef __cplusplus
1062}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001063
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001064namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001065 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001066 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001067
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001068 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1069 inline ty *unwrap(ref P) { \
1070 return reinterpret_cast<ty*>(P); \
1071 } \
1072 \
1073 inline ref wrap(const ty *P) { \
1074 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1075 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001076
Gordon Henriksen878114b2008-03-16 04:20:44 +00001077 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1078 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1079 \
1080 template<typename T> \
1081 inline T *unwrap(ref P) { \
1082 return cast<T>(unwrap(P)); \
1083 }
1084
1085 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1086 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1087 \
1088 template<typename T> \
1089 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001090 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001091 assert(Q && "Invalid cast!"); \
1092 return Q; \
1093 }
1094
1095 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1096 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001097 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1098 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001099 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001100 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001101 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001102 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001103 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001104 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001105 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1106 * Module.
1107 */
1108 inline Module *unwrap(LLVMModuleProviderRef MP) {
1109 return reinterpret_cast<Module*>(MP);
1110 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001111
Gordon Henriksen878114b2008-03-16 04:20:44 +00001112 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1113 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001114 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001115
1116 /* Specialized opaque context conversions.
1117 */
1118 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1119 return reinterpret_cast<LLVMContext**>(Tys);
1120 }
1121
1122 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1123 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1124 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001125
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001126 /* Specialized opaque type conversions.
1127 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001128 inline Type **unwrap(LLVMTypeRef* Tys) {
1129 return reinterpret_cast<Type**>(Tys);
1130 }
1131
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001132 inline LLVMTypeRef *wrap(const Type **Tys) {
1133 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1134 }
1135
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001136 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001137 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001138 inline Value **unwrap(LLVMValueRef *Vals) {
1139 return reinterpret_cast<Value**>(Vals);
1140 }
1141
1142 template<typename T>
1143 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1144 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001145 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001146 cast<T>(*I);
1147 #endif
1148 return reinterpret_cast<T**>(Vals);
1149 }
1150
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001151 inline LLVMValueRef *wrap(const Value **Vals) {
1152 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1153 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001154}
1155
1156#endif /* !defined(__cplusplus) */
1157
1158#endif /* !defined(LLVM_C_CORE_H) */