blob: 733b92c57c8d360cdd8274b4c64c4907600f2832 [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 */
229 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
Gordon Henriksen76a03742007-09-18 03:18:57 +0000322
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000323/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000324
325/* LLVM types conform to the following hierarchy:
326 *
327 * types:
328 * integer type
329 * real type
330 * function type
331 * sequence types:
332 * array type
333 * pointer type
334 * vector type
335 * void type
336 * label type
337 * opaque type
338 */
339
Gordon Henriksena49d4352008-03-07 19:13:06 +0000340/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000341LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000342
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000343/** See llvm::LLVMType::getContext. */
344LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
345
Gordon Henriksen76a03742007-09-18 03:18:57 +0000346/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000347LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
348LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
349LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
350LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
351LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
352LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
353
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000354LLVMTypeRef LLVMInt1Type(void);
355LLVMTypeRef LLVMInt8Type(void);
356LLVMTypeRef LLVMInt16Type(void);
357LLVMTypeRef LLVMInt32Type(void);
358LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000359LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000360unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000361
362/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000363LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
364LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
365LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
366LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
367LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
368
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000369LLVMTypeRef LLVMFloatType(void);
370LLVMTypeRef LLVMDoubleType(void);
371LLVMTypeRef LLVMX86FP80Type(void);
372LLVMTypeRef LLVMFP128Type(void);
373LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000374
375/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000376LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
377 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000378 LLVMBool IsVarArg);
379LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000380LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
381unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
382void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000383
384/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000385LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000386 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000387LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000388 LLVMBool Packed);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000389unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000390void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000391LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000392
Chris Lattner392be582010-02-12 20:49:41 +0000393/* Operations on union types */
394LLVMTypeRef LLVMUnionTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
395 unsigned ElementCount);
396LLVMTypeRef LLVMUnionType(LLVMTypeRef *ElementTypes, unsigned ElementCount);
397unsigned LLVMCountUnionElementTypes(LLVMTypeRef UnionTy);
398void LLVMGetUnionElementTypes(LLVMTypeRef UnionTy, LLVMTypeRef *Dest);
399
Gordon Henriksen76a03742007-09-18 03:18:57 +0000400/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000401LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000402LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000403LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000404
405LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
406unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000407unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000408unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
409
410/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000411LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
412LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
413LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
414
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000415LLVMTypeRef LLVMVoidType(void);
416LLVMTypeRef LLVMLabelType(void);
417LLVMTypeRef LLVMOpaqueType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000418
Gordon Henriksenffb48762007-10-07 00:13:35 +0000419/* Operations on type handles */
420LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
421void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
422LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
423void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
424
Gordon Henriksen76a03742007-09-18 03:18:57 +0000425
426/*===-- Values ------------------------------------------------------------===*/
427
428/* The bulk of LLVM's object model consists of values, which comprise a very
429 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000430 */
431
Gordon Henriksen29e38942008-12-19 18:39:45 +0000432#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
433 macro(Argument) \
434 macro(BasicBlock) \
435 macro(InlineAsm) \
436 macro(User) \
437 macro(Constant) \
438 macro(ConstantAggregateZero) \
439 macro(ConstantArray) \
440 macro(ConstantExpr) \
441 macro(ConstantFP) \
442 macro(ConstantInt) \
443 macro(ConstantPointerNull) \
444 macro(ConstantStruct) \
445 macro(ConstantVector) \
446 macro(GlobalValue) \
447 macro(Function) \
448 macro(GlobalAlias) \
449 macro(GlobalVariable) \
450 macro(UndefValue) \
451 macro(Instruction) \
452 macro(BinaryOperator) \
453 macro(CallInst) \
454 macro(IntrinsicInst) \
455 macro(DbgInfoIntrinsic) \
456 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000457 macro(EHSelectorInst) \
458 macro(MemIntrinsic) \
459 macro(MemCpyInst) \
460 macro(MemMoveInst) \
461 macro(MemSetInst) \
462 macro(CmpInst) \
463 macro(FCmpInst) \
464 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000465 macro(ExtractElementInst) \
466 macro(GetElementPtrInst) \
467 macro(InsertElementInst) \
468 macro(InsertValueInst) \
469 macro(PHINode) \
470 macro(SelectInst) \
471 macro(ShuffleVectorInst) \
472 macro(StoreInst) \
473 macro(TerminatorInst) \
474 macro(BranchInst) \
475 macro(InvokeInst) \
476 macro(ReturnInst) \
477 macro(SwitchInst) \
478 macro(UnreachableInst) \
479 macro(UnwindInst) \
480 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000481 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000482 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000483 macro(BitCastInst) \
484 macro(FPExtInst) \
485 macro(FPToSIInst) \
486 macro(FPToUIInst) \
487 macro(FPTruncInst) \
488 macro(IntToPtrInst) \
489 macro(PtrToIntInst) \
490 macro(SExtInst) \
491 macro(SIToFPInst) \
492 macro(TruncInst) \
493 macro(UIToFPInst) \
494 macro(ZExtInst) \
495 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000496 macro(LoadInst) \
497 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000498
Gordon Henriksen76a03742007-09-18 03:18:57 +0000499/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000500LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000501const char *LLVMGetValueName(LLVMValueRef Val);
502void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000503void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000504void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000505int LLVMHasMetadata(LLVMValueRef Val);
506LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
507void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000508
Gordon Henriksen29e38942008-12-19 18:39:45 +0000509/* Conversion functions. Return the input value if it is an instance of the
510 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
511#define LLVM_DECLARE_VALUE_CAST(name) \
512 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
513LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
514
Chris Lattner40cf28d2009-10-12 04:01:02 +0000515/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000516LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
517LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
518LLVMValueRef LLVMGetUser(LLVMUseRef U);
519LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000520
521/* Operations on Users */
522LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
523
Gordon Henriksen76a03742007-09-18 03:18:57 +0000524/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000525LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
526LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000527LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000528LLVMBool LLVMIsConstant(LLVMValueRef Val);
529LLVMBool LLVMIsNull(LLVMValueRef Val);
530LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000531LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000532
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000533/* Operations on metadata */
534LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
535 unsigned SLen);
536LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
537LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
538 unsigned Count);
539LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
540
Gordon Henriksen76a03742007-09-18 03:18:57 +0000541/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000542LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000543 LLVMBool SignExtend);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000544LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
545 uint8_t Radix);
546LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
547 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000548LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000549LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000550LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
551 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000552unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
553long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000554
Gordon Henriksen76a03742007-09-18 03:18:57 +0000555
556/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000557LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000558 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000559LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
560 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000561 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000562
Gordon Henriksen1046c732007-10-06 15:11:06 +0000563LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000564 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000565LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000566 LLVMValueRef *ConstantVals, unsigned Length);
567LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000568 LLVMBool Packed);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000569LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Erick Tryzelaara8053df2010-02-28 05:51:33 +0000570LLVMValueRef LLVMConstUnion(LLVMTypeRef Ty, LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000571
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000572/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000573LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000574LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000575LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
576LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000577LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
578LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000579LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000580LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
581LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000582LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000583LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000584LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000585LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000586LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
587LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000588LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000589LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000590LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
591LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000592LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000593LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
594LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000595LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000596LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
597LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
598LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
599LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
600LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
601LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
602LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
604 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
605LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
606 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
607LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
609LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
611 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000612LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
613 LLVMValueRef *ConstantIndices,
614 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000615LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
616LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
617LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
618LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
619LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
620LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
621LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
622LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
623LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
624LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
625LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
626LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000627LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
628 LLVMTypeRef ToType);
629LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
630 LLVMTypeRef ToType);
631LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
632 LLVMTypeRef ToType);
633LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
634 LLVMTypeRef ToType);
635LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000636 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000637LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000638LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
639 LLVMValueRef ConstantIfTrue,
640 LLVMValueRef ConstantIfFalse);
641LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
642 LLVMValueRef IndexConstant);
643LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
644 LLVMValueRef ElementValueConstant,
645 LLVMValueRef IndexConstant);
646LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
647 LLVMValueRef VectorBConstant,
648 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000649LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
650 unsigned NumIdx);
651LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
652 LLVMValueRef ElementValueConstant,
653 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000654LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000655 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000656 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000657LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000658
Gordon Henriksen76a03742007-09-18 03:18:57 +0000659/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000660LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000661LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000662LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
663void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
664const char *LLVMGetSection(LLVMValueRef Global);
665void LLVMSetSection(LLVMValueRef Global, const char *Section);
666LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
667void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
668unsigned LLVMGetAlignment(LLVMValueRef Global);
669void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
670
671/* Operations on global variables */
672LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000673LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
674 const char *Name,
675 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000676LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000677LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
678LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
679LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
680LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000681void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000682LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
683void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000684LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
685void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
686LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
687void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000688
Chris Lattner3d1f5522008-12-17 21:39:50 +0000689/* Operations on aliases */
690LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
691 const char *Name);
692
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000693/* Operations on functions */
694LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
695 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000696LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000697LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
698LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
699LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
700LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000701void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000702unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
703unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
704void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000705const char *LLVMGetGC(LLVMValueRef Fn);
706void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000707void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000708LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000709void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000710
Gordon Henriksen265f7802008-03-19 01:11:35 +0000711/* Operations on parameters */
712unsigned LLVMCountParams(LLVMValueRef Fn);
713void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
714LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
715LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000716LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
717LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
718LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
719LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000720void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
721void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000722LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000723void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000724
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000725/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000726LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000727LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000728LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000729LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000730unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
731void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000732LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
733LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
734LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
735LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000736LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000737
738LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
739 LLVMValueRef Fn,
740 const char *Name);
741LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
742 LLVMBasicBlockRef BB,
743 const char *Name);
744
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000745LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
746LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
747 const char *Name);
748void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
749
Gordon Henriksen265f7802008-03-19 01:11:35 +0000750/* Operations on instructions */
751LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000752LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
753LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
754LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
755LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000756
Gordon Henriksen1158c532007-12-29 20:45:00 +0000757/* Operations on call sites */
758void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
759unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000760void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
761void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
762 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000763void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
764 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000765
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000766/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000767LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
768void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000769
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000770/* Operations on phi nodes */
771void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
772 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
773unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
774LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
775LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000776
777/*===-- Instruction builders ----------------------------------------------===*/
778
779/* An instruction builder represents a point within a basic block, and is the
780 * exclusive means of building instructions using the C interface.
781 */
782
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000783LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000784LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000785void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
786 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000787void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
788void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000789LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000790void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
791void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000792void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
793 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000794void LLVMDisposeBuilder(LLVMBuilderRef Builder);
795
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000796/* Metadata */
797void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
798LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
799void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
800
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000801/* Terminators */
802LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
803LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000804LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000805 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000806LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
807LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
808 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
809LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
810 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000811LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
812 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000813LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
814 LLVMValueRef *Args, unsigned NumArgs,
815 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
816 const char *Name);
817LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
818LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
819
Gordon Henriksen097102c2008-01-01 05:50:53 +0000820/* Add a case to the switch instruction */
821void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
822 LLVMBasicBlockRef Dest);
823
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000824/* Add a destination to the indirectbr instruction */
825void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
826
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000827/* Arithmetic */
828LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
829 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000830LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
831 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000832LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
833 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000834LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
835 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000836LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
837 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000838LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
839 const char *Name);
840LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
841 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000842LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
843 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000844LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
845 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000846LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
847 const char *Name);
848LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
849 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000850LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
851 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000852LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
853 const char *Name);
854LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
855 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000856LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
857 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000858LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
859 const char *Name);
860LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
861 const char *Name);
862LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
863 const char *Name);
864LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
865 const char *Name);
866LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
867 const char *Name);
868LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
869 const char *Name);
870LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
871 const char *Name);
872LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
873 const char *Name);
874LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
875 const char *Name);
876LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
877 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000878LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
879 LLVMValueRef LHS, LLVMValueRef RHS,
880 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000881LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000882LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
883 const char *Name);
884LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
885 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000886LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000887LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
888
889/* Memory */
890LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
891LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
892 LLVMValueRef Val, const char *Name);
893LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
894LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
895 LLVMValueRef Val, const char *Name);
896LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
897LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
898 const char *Name);
899LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
900LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
901 LLVMValueRef *Indices, unsigned NumIndices,
902 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000903LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
904 LLVMValueRef *Indices, unsigned NumIndices,
905 const char *Name);
906LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
907 unsigned Idx, const char *Name);
908LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
909 const char *Name);
910LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
911 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000912
913/* Casts */
914LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
915 LLVMTypeRef DestTy, const char *Name);
916LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
917 LLVMTypeRef DestTy, const char *Name);
918LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
919 LLVMTypeRef DestTy, const char *Name);
920LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
921 LLVMTypeRef DestTy, const char *Name);
922LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
923 LLVMTypeRef DestTy, const char *Name);
924LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
925 LLVMTypeRef DestTy, const char *Name);
926LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
927 LLVMTypeRef DestTy, const char *Name);
928LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
929 LLVMTypeRef DestTy, const char *Name);
930LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
931 LLVMTypeRef DestTy, const char *Name);
932LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
933 LLVMTypeRef DestTy, const char *Name);
934LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
935 LLVMTypeRef DestTy, const char *Name);
936LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
937 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000938LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
939 LLVMTypeRef DestTy, const char *Name);
940LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
941 LLVMTypeRef DestTy, const char *Name);
942LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
943 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000944LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
945 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000946LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
947 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000948LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000949 LLVMTypeRef DestTy, const char *Name);
950LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
951 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000952
953/* Comparisons */
954LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
955 LLVMValueRef LHS, LLVMValueRef RHS,
956 const char *Name);
957LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
958 LLVMValueRef LHS, LLVMValueRef RHS,
959 const char *Name);
960
961/* Miscellaneous instructions */
962LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
963LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
964 LLVMValueRef *Args, unsigned NumArgs,
965 const char *Name);
966LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
967 LLVMValueRef Then, LLVMValueRef Else,
968 const char *Name);
969LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
970 const char *Name);
971LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
972 LLVMValueRef Index, const char *Name);
973LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
974 LLVMValueRef EltVal, LLVMValueRef Index,
975 const char *Name);
976LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
977 LLVMValueRef V2, LLVMValueRef Mask,
978 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000979LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
980 unsigned Index, const char *Name);
981LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
982 LLVMValueRef EltVal, unsigned Index,
983 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000984
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000985LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
986 const char *Name);
987LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
988 const char *Name);
989LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
990 LLVMValueRef RHS, const char *Name);
991
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000992
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000993/*===-- Module providers --------------------------------------------------===*/
994
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000995/* Changes the type of M so it can be passed to FunctionPassManagers and the
996 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000997 */
998LLVMModuleProviderRef
999LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1000
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001001/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001002 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001003void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001004
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001005
1006/*===-- Memory buffers ----------------------------------------------------===*/
1007
Chris Lattner25963c62010-01-09 22:27:07 +00001008LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1009 LLVMMemoryBufferRef *OutMemBuf,
1010 char **OutMessage);
1011LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1012 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001013void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1014
Gordon Henriksen878114b2008-03-16 04:20:44 +00001015
1016/*===-- Pass Managers -----------------------------------------------------===*/
1017
1018/** Constructs a new whole-module pass pipeline. This type of pipeline is
1019 suitable for link-time optimization and whole-module transformations.
1020 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001021LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001022
1023/** Constructs a new function-by-function pass pipeline over the module
1024 provider. It does not take ownership of the module provider. This type of
1025 pipeline is suitable for code generation and JIT compilation tasks.
1026 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001027LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1028
1029/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001030LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1031
1032/** Initializes, executes on the provided module, and finalizes all of the
1033 passes scheduled in the pass manager. Returns 1 if any of the passes
1034 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001035LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001036
1037/** Initializes all of the function passes scheduled in the function pass
1038 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1039 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001040LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001041
1042/** Executes all of the function passes scheduled in the function pass manager
1043 on the provided function. Returns 1 if any of the passes modified the
1044 function, false otherwise.
1045 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001046LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001047
1048/** Finalizes all of the function passes scheduled in in the function pass
1049 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1050 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001051LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001052
1053/** Frees the memory of a pass pipeline. For function pipelines, does not free
1054 the module provider.
1055 See llvm::PassManagerBase::~PassManagerBase. */
1056void LLVMDisposePassManager(LLVMPassManagerRef PM);
1057
1058
Gordon Henriksen76a03742007-09-18 03:18:57 +00001059#ifdef __cplusplus
1060}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001061
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001062namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001063 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001064 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001065
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001066 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1067 inline ty *unwrap(ref P) { \
1068 return reinterpret_cast<ty*>(P); \
1069 } \
1070 \
1071 inline ref wrap(const ty *P) { \
1072 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1073 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001074
Gordon Henriksen878114b2008-03-16 04:20:44 +00001075 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1076 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1077 \
1078 template<typename T> \
1079 inline T *unwrap(ref P) { \
1080 return cast<T>(unwrap(P)); \
1081 }
1082
1083 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1084 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1085 \
1086 template<typename T> \
1087 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001088 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001089 assert(Q && "Invalid cast!"); \
1090 return Q; \
1091 }
1092
1093 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1094 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001095 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1096 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001097 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001098 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001099 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001100 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001101 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001102 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001103 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1104 * Module.
1105 */
1106 inline Module *unwrap(LLVMModuleProviderRef MP) {
1107 return reinterpret_cast<Module*>(MP);
1108 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001109
Gordon Henriksen878114b2008-03-16 04:20:44 +00001110 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1111 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001112 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001113
1114 /* Specialized opaque context conversions.
1115 */
1116 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1117 return reinterpret_cast<LLVMContext**>(Tys);
1118 }
1119
1120 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1121 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1122 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001123
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001124 /* Specialized opaque type conversions.
1125 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001126 inline Type **unwrap(LLVMTypeRef* Tys) {
1127 return reinterpret_cast<Type**>(Tys);
1128 }
1129
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001130 inline LLVMTypeRef *wrap(const Type **Tys) {
1131 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1132 }
1133
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001134 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001135 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001136 inline Value **unwrap(LLVMValueRef *Vals) {
1137 return reinterpret_cast<Value**>(Vals);
1138 }
1139
1140 template<typename T>
1141 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1142 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001143 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001144 cast<T>(*I);
1145 #endif
1146 return reinterpret_cast<T**>(Vals);
1147 }
1148
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001149 inline LLVMValueRef *wrap(const Value **Vals) {
1150 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1151 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001152}
1153
1154#endif /* !defined(__cplusplus) */
1155
1156#endif /* !defined(LLVM_C_CORE_H) */