blob: fc33ab7f824d5712e1eb3ca021df89327be48e08 [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
Michael J. Spencerab425d82010-11-29 18:47:54 +000036#include "llvm/Support/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"
Owen Anderson4698c5d2010-10-07 17:55:47 +000043#include "llvm/PassRegistry.h"
Duncan Sandsa07136e2008-04-13 06:22:09 +000044#include "llvm/Support/IRBuilder.h"
Gordon Henriksen7330acd2007-10-05 23:59:36 +000045
Gordon Henriksen76a03742007-09-18 03:18:57 +000046extern "C" {
47#endif
48
49
Chris Lattner25963c62010-01-09 22:27:07 +000050typedef int LLVMBool;
51
Gordon Henriksen76a03742007-09-18 03:18:57 +000052/* Opaque types. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000053
54/**
Owen Anderson6773d382009-07-01 16:58:40 +000055 * The top-level container for all LLVM global data. See the LLVMContext class.
56 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +000057typedef struct LLVMOpaqueContext *LLVMContextRef;
Owen Anderson6773d382009-07-01 16:58:40 +000058
59/**
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000060 * The top-level container for all other LLVM Intermediate Representation (IR)
61 * objects. See the llvm::Module class.
62 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000063typedef struct LLVMOpaqueModule *LLVMModuleRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000064
65/**
Gordon Henriksena49d4352008-03-07 19:13:06 +000066 * Each value in the LLVM IR has a type, an LLVMTypeRef. See the llvm::Type
67 * class.
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000068 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000069typedef struct LLVMOpaqueType *LLVMTypeRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000070
Gordon Henriksen76a03742007-09-18 03:18:57 +000071typedef struct LLVMOpaqueValue *LLVMValueRef;
Gordon Henriksenc23b66c2007-09-26 20:56:12 +000072typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
73typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000074
Jeffrey Yasskin091217b2010-01-27 20:34:15 +000075/* Interface used to provide a module to JIT or interpreter. This is now just a
76 * synonym for llvm::Module, but we have to keep using the different type to
77 * keep binary compatibility.
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000078 */
Gordon Henriksen0a68fe22007-12-12 01:04:30 +000079typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
Gordon Henriksen76a03742007-09-18 03:18:57 +000080
Gordon Henriksen34eb6d82007-12-19 22:30:40 +000081/* Used to provide a module to JIT or interpreter.
82 * See the llvm::MemoryBuffer class.
83 */
84typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
85
Gordon Henriksen878114b2008-03-16 04:20:44 +000086/** See the llvm::PassManagerBase class. */
87typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
88
Owen Anderson4698c5d2010-10-07 17:55:47 +000089/** See the llvm::PassRegistry class. */
90typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef;
91
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +000092/** Used to get the users and usees of a Value. See the llvm::Use class. */
93typedef struct LLVMOpaqueUse *LLVMUseRef;
Chris Lattner40cf28d2009-10-12 04:01:02 +000094
Gordon Henriksen76a03742007-09-18 03:18:57 +000095typedef enum {
Devang Patel4c758ea2008-09-25 21:00:45 +000096 LLVMZExtAttribute = 1<<0,
97 LLVMSExtAttribute = 1<<1,
98 LLVMNoReturnAttribute = 1<<2,
99 LLVMInRegAttribute = 1<<3,
100 LLVMStructRetAttribute = 1<<4,
101 LLVMNoUnwindAttribute = 1<<5,
102 LLVMNoAliasAttribute = 1<<6,
103 LLVMByValAttribute = 1<<7,
104 LLVMNestAttribute = 1<<8,
105 LLVMReadNoneAttribute = 1<<9,
Anton Korobeynikovc8ce7b082009-07-17 18:07:26 +0000106 LLVMReadOnlyAttribute = 1<<10,
Anton Korobeynikov9750be92009-07-17 18:57:16 +0000107 LLVMNoInlineAttribute = 1<<11,
108 LLVMAlwaysInlineAttribute = 1<<12,
109 LLVMOptimizeForSizeAttribute = 1<<13,
110 LLVMStackProtectAttribute = 1<<14,
111 LLVMStackProtectReqAttribute = 1<<15,
Erick Tryzelaar8f69fea2010-03-03 23:51:25 +0000112 LLVMAlignment = 31<<16,
Anton Korobeynikov9750be92009-07-17 18:57:16 +0000113 LLVMNoCaptureAttribute = 1<<21,
114 LLVMNoRedZoneAttribute = 1<<22,
115 LLVMNoImplicitFloatAttribute = 1<<23,
Jakob Stoklund Olesen74bb06c2010-02-06 01:16:28 +0000116 LLVMNakedAttribute = 1<<24,
Erick Tryzelaar8f69fea2010-03-03 23:51:25 +0000117 LLVMInlineHintAttribute = 1<<25,
118 LLVMStackAlignment = 7<<26
Devang Patel4c758ea2008-09-25 21:00:45 +0000119} LLVMAttribute;
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000120
121typedef enum {
Bill Wendlingda52cec2010-02-15 20:53:17 +0000122 /* Terminator Instructions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000123 LLVMRet = 1,
124 LLVMBr = 2,
125 LLVMSwitch = 3,
Bill Wendling07d6d762010-02-15 20:50:51 +0000126 LLVMIndirectBr = 4,
127 LLVMInvoke = 5,
128 LLVMUnwind = 6,
129 LLVMUnreachable = 7,
130
Bill Wendlingda52cec2010-02-15 20:53:17 +0000131 /* Standard Binary Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000132 LLVMAdd = 8,
133 LLVMFAdd = 9,
134 LLVMSub = 10,
135 LLVMFSub = 11,
136 LLVMMul = 12,
137 LLVMFMul = 13,
138 LLVMUDiv = 14,
139 LLVMSDiv = 15,
140 LLVMFDiv = 16,
141 LLVMURem = 17,
142 LLVMSRem = 18,
143 LLVMFRem = 19,
144
Bill Wendlingda52cec2010-02-15 20:53:17 +0000145 /* Logical Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000146 LLVMShl = 20,
147 LLVMLShr = 21,
148 LLVMAShr = 22,
149 LLVMAnd = 23,
150 LLVMOr = 24,
151 LLVMXor = 25,
152
Bill Wendlingda52cec2010-02-15 20:53:17 +0000153 /* Memory Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000154 LLVMAlloca = 26,
155 LLVMLoad = 27,
156 LLVMStore = 28,
157 LLVMGetElementPtr = 29,
158
Bill Wendlingda52cec2010-02-15 20:53:17 +0000159 /* Cast Operators */
Erick Tryzelaar5bf1a322010-02-16 03:45:23 +0000160 LLVMTrunc = 30,
Bill Wendling07d6d762010-02-15 20:50:51 +0000161 LLVMZExt = 31,
162 LLVMSExt = 32,
163 LLVMFPToUI = 33,
164 LLVMFPToSI = 34,
165 LLVMUIToFP = 35,
166 LLVMSIToFP = 36,
167 LLVMFPTrunc = 37,
168 LLVMFPExt = 38,
169 LLVMPtrToInt = 39,
170 LLVMIntToPtr = 40,
171 LLVMBitCast = 41,
172
Bill Wendlingda52cec2010-02-15 20:53:17 +0000173 /* Other Operators */
Bill Wendling07d6d762010-02-15 20:50:51 +0000174 LLVMICmp = 42,
175 LLVMFCmp = 43,
176 LLVMPHI = 44,
177 LLVMCall = 45,
178 LLVMSelect = 46,
Bill Wendlingda52cec2010-02-15 20:53:17 +0000179 /* UserOp1 */
180 /* UserOp2 */
Bill Wendling07d6d762010-02-15 20:50:51 +0000181 LLVMVAArg = 49,
182 LLVMExtractElement = 50,
183 LLVMInsertElement = 51,
184 LLVMShuffleVector = 52,
185 LLVMExtractValue = 53,
186 LLVMInsertValue = 54
Chris Lattner40cf28d2009-10-12 04:01:02 +0000187} LLVMOpcode;
188
189typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000190 LLVMVoidTypeKind, /**< type with no size */
191 LLVMFloatTypeKind, /**< 32 bit floating point type */
192 LLVMDoubleTypeKind, /**< 64 bit floating point type */
193 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
194 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
195 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
196 LLVMLabelTypeKind, /**< Labels */
197 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
198 LLVMFunctionTypeKind, /**< Functions */
199 LLVMStructTypeKind, /**< Structures */
200 LLVMArrayTypeKind, /**< Arrays */
201 LLVMPointerTypeKind, /**< Pointers */
Chris Lattnerdac44ec2009-07-15 22:00:31 +0000202 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
Dale Johannesenbaa5d042010-09-10 20:55:01 +0000203 LLVMMetadataTypeKind, /**< Metadata */
204 LLVMX86_MMXTypeKind /**< X86 MMX */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000205} LLVMTypeKind;
206
207typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000208 LLVMExternalLinkage, /**< Externally visible function */
Chris Lattner2dba0f02009-04-13 06:25:37 +0000209 LLVMAvailableExternallyLinkage,
Duncan Sands12da8ce2009-03-07 15:45:40 +0000210 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
211 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
212 equivalent. */
213 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
214 LLVMWeakODRLinkage, /**< Same, but only replaced by something
215 equivalent. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000216 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
217 LLVMInternalLinkage, /**< Rename collisions when linking (static
218 functions) */
Duncan Sands12da8ce2009-03-07 15:45:40 +0000219 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000220 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
221 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
Duncan Sandse2881052009-03-11 08:08:06 +0000222 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000223 LLVMGhostLinkage, /**< Obsolete */
Bill Wendling002b1672009-07-20 18:22:52 +0000224 LLVMCommonLinkage, /**< Tentative definitions */
Bill Wendling03bcd6e2010-07-01 21:55:59 +0000225 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
Bill Wendling578ee402010-08-20 22:05:50 +0000226 LLVMLinkerPrivateWeakLinkage, /**< Like LinkerPrivate, but is weak. */
227 LLVMLinkerPrivateWeakDefAutoLinkage /**< Like LinkerPrivateWeak, but possibly
228 hidden. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000229} LLVMLinkage;
230
231typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000232 LLVMDefaultVisibility, /**< The GV is visible */
233 LLVMHiddenVisibility, /**< The GV is hidden */
234 LLVMProtectedVisibility /**< The GV is protected */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000235} LLVMVisibility;
236
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000237typedef enum {
238 LLVMCCallConv = 0,
239 LLVMFastCallConv = 8,
240 LLVMColdCallConv = 9,
241 LLVMX86StdcallCallConv = 64,
242 LLVMX86FastcallCallConv = 65
243} LLVMCallConv;
244
245typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000246 LLVMIntEQ = 32, /**< equal */
247 LLVMIntNE, /**< not equal */
248 LLVMIntUGT, /**< unsigned greater than */
249 LLVMIntUGE, /**< unsigned greater or equal */
250 LLVMIntULT, /**< unsigned less than */
251 LLVMIntULE, /**< unsigned less or equal */
252 LLVMIntSGT, /**< signed greater than */
253 LLVMIntSGE, /**< signed greater or equal */
254 LLVMIntSLT, /**< signed less than */
255 LLVMIntSLE /**< signed less or equal */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000256} LLVMIntPredicate;
257
258typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000259 LLVMRealPredicateFalse, /**< Always false (always folded) */
260 LLVMRealOEQ, /**< True if ordered and equal */
261 LLVMRealOGT, /**< True if ordered and greater than */
262 LLVMRealOGE, /**< True if ordered and greater than or equal */
263 LLVMRealOLT, /**< True if ordered and less than */
264 LLVMRealOLE, /**< True if ordered and less than or equal */
265 LLVMRealONE, /**< True if ordered and operands are unequal */
266 LLVMRealORD, /**< True if ordered (no nans) */
267 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
268 LLVMRealUEQ, /**< True if unordered or equal */
269 LLVMRealUGT, /**< True if unordered or greater than */
270 LLVMRealUGE, /**< True if unordered, greater than, or equal */
271 LLVMRealULT, /**< True if unordered or less than */
272 LLVMRealULE, /**< True if unordered, less than, or equal */
273 LLVMRealUNE, /**< True if unordered or not equal */
274 LLVMRealPredicateTrue /**< Always true (always folded) */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000275} LLVMRealPredicate;
276
Nick Lewycky0db26542011-05-15 07:20:34 +0000277void LLVMInitializeCore(LLVMPassRegistryRef R);
278
Gordon Henriksen76a03742007-09-18 03:18:57 +0000279
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000280/*===-- Error handling ----------------------------------------------------===*/
281
282void LLVMDisposeMessage(char *Message);
283
284
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000285/*===-- Contexts ----------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000286
Owen Anderson6773d382009-07-01 16:58:40 +0000287/* Create and destroy contexts. */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000288LLVMContextRef LLVMContextCreate(void);
289LLVMContextRef LLVMGetGlobalContext(void);
Owen Anderson6773d382009-07-01 16:58:40 +0000290void LLVMContextDispose(LLVMContextRef C);
291
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000292unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
293 unsigned SLen);
294unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
295
296/*===-- Modules -----------------------------------------------------------===*/
297
Gordon Henriksen76a03742007-09-18 03:18:57 +0000298/* Create and destroy modules. */
Gordon Henriksena49d4352008-03-07 19:13:06 +0000299/** See llvm::Module::Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000300LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Owen Anderson31d44e42009-07-02 07:17:57 +0000301LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
302 LLVMContextRef C);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000303
304/** See llvm::Module::~Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000305void LLVMDisposeModule(LLVMModuleRef M);
306
Gordon Henriksena49d4352008-03-07 19:13:06 +0000307/** Data layout. See Module::getDataLayout. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000308const char *LLVMGetDataLayout(LLVMModuleRef M);
309void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
310
Gordon Henriksena49d4352008-03-07 19:13:06 +0000311/** Target triple. See Module::getTargetTriple. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000312const char *LLVMGetTarget(LLVMModuleRef M);
313void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
314
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000315/** See Module::dump. */
316void LLVMDumpModule(LLVMModuleRef M);
317
Chris Lattner26941452010-04-10 17:52:58 +0000318/** See Module::setModuleInlineAsm. */
319void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000320
Chris Lattnera7e04b02010-11-28 20:03:44 +0000321/** See Module::getContext. */
322LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
323
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000324/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000325
326/* LLVM types conform to the following hierarchy:
327 *
328 * types:
329 * integer type
330 * real type
331 * function type
332 * sequence types:
333 * array type
334 * pointer type
335 * vector type
336 * void type
337 * label type
338 * opaque type
339 */
340
Gordon Henriksena49d4352008-03-07 19:13:06 +0000341/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000342LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000343
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000344/** See llvm::LLVMType::getContext. */
345LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
346
Gordon Henriksen76a03742007-09-18 03:18:57 +0000347/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000348LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
349LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
350LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
351LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
352LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
353LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
354
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000355LLVMTypeRef LLVMInt1Type(void);
356LLVMTypeRef LLVMInt8Type(void);
357LLVMTypeRef LLVMInt16Type(void);
358LLVMTypeRef LLVMInt32Type(void);
359LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000360LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000361unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000362
363/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000364LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
365LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
366LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
367LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
368LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
369
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000370LLVMTypeRef LLVMFloatType(void);
371LLVMTypeRef LLVMDoubleType(void);
372LLVMTypeRef LLVMX86FP80Type(void);
373LLVMTypeRef LLVMFP128Type(void);
374LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000375
376/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000377LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
378 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000379 LLVMBool IsVarArg);
380LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000381LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
382unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
383void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000384
385/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000386LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000387 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000388LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000389 LLVMBool Packed);
Chris Lattnere71ccde2011-07-14 05:53:17 +0000390LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
391void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
392 unsigned ElementCount, LLVMBool Packed);
393
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000394unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000395void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000396LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Chris Lattner17cf05b2011-07-14 16:20:28 +0000397LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
398
399LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000400
401/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000402LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000403LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000404LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000405
406LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
407unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000408unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000409unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
410
411/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000412LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
413LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000414LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000415
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000416LLVMTypeRef LLVMVoidType(void);
417LLVMTypeRef LLVMLabelType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000418LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000419
Gordon Henriksen76a03742007-09-18 03:18:57 +0000420/*===-- Values ------------------------------------------------------------===*/
421
422/* The bulk of LLVM's object model consists of values, which comprise a very
423 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000424 */
425
Gordon Henriksen29e38942008-12-19 18:39:45 +0000426#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
427 macro(Argument) \
428 macro(BasicBlock) \
429 macro(InlineAsm) \
430 macro(User) \
431 macro(Constant) \
432 macro(ConstantAggregateZero) \
433 macro(ConstantArray) \
434 macro(ConstantExpr) \
435 macro(ConstantFP) \
436 macro(ConstantInt) \
437 macro(ConstantPointerNull) \
438 macro(ConstantStruct) \
439 macro(ConstantVector) \
440 macro(GlobalValue) \
441 macro(Function) \
442 macro(GlobalAlias) \
443 macro(GlobalVariable) \
444 macro(UndefValue) \
445 macro(Instruction) \
446 macro(BinaryOperator) \
447 macro(CallInst) \
448 macro(IntrinsicInst) \
449 macro(DbgInfoIntrinsic) \
450 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000451 macro(EHSelectorInst) \
452 macro(MemIntrinsic) \
453 macro(MemCpyInst) \
454 macro(MemMoveInst) \
455 macro(MemSetInst) \
456 macro(CmpInst) \
457 macro(FCmpInst) \
458 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000459 macro(ExtractElementInst) \
460 macro(GetElementPtrInst) \
461 macro(InsertElementInst) \
462 macro(InsertValueInst) \
463 macro(PHINode) \
464 macro(SelectInst) \
465 macro(ShuffleVectorInst) \
466 macro(StoreInst) \
467 macro(TerminatorInst) \
468 macro(BranchInst) \
469 macro(InvokeInst) \
470 macro(ReturnInst) \
471 macro(SwitchInst) \
472 macro(UnreachableInst) \
473 macro(UnwindInst) \
474 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000475 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000476 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000477 macro(BitCastInst) \
478 macro(FPExtInst) \
479 macro(FPToSIInst) \
480 macro(FPToUIInst) \
481 macro(FPTruncInst) \
482 macro(IntToPtrInst) \
483 macro(PtrToIntInst) \
484 macro(SExtInst) \
485 macro(SIToFPInst) \
486 macro(TruncInst) \
487 macro(UIToFPInst) \
488 macro(ZExtInst) \
489 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000490 macro(LoadInst) \
491 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000492
Gordon Henriksen76a03742007-09-18 03:18:57 +0000493/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000494LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000495const char *LLVMGetValueName(LLVMValueRef Val);
496void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000497void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000498void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000499int LLVMHasMetadata(LLVMValueRef Val);
500LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
501void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000502
Gordon Henriksen29e38942008-12-19 18:39:45 +0000503/* Conversion functions. Return the input value if it is an instance of the
504 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
505#define LLVM_DECLARE_VALUE_CAST(name) \
506 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
507LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
508
Chris Lattner40cf28d2009-10-12 04:01:02 +0000509/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000510LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
511LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
512LLVMValueRef LLVMGetUser(LLVMUseRef U);
513LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000514
515/* Operations on Users */
516LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Erick Tryzelaarb4d48702010-08-20 14:51:22 +0000517void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
518int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000519
Gordon Henriksen76a03742007-09-18 03:18:57 +0000520/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000521LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
522LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000523LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000524LLVMBool LLVMIsConstant(LLVMValueRef Val);
525LLVMBool LLVMIsNull(LLVMValueRef Val);
526LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000527LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000528
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000529/* Operations on metadata */
530LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
531 unsigned SLen);
532LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
533LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
534 unsigned Count);
535LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
536
Gordon Henriksen76a03742007-09-18 03:18:57 +0000537/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000538LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000539 LLVMBool SignExtend);
Chris Lattner4329e072010-11-23 02:47:22 +0000540LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
541 unsigned NumWords,
542 const uint64_t Words[]);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000543LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
544 uint8_t Radix);
545LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
546 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000547LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000548LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000549LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
550 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000551unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
552long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000553
Gordon Henriksen76a03742007-09-18 03:18:57 +0000554
555/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000556LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000557 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000558LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
559 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000560 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000561
Gordon Henriksen1046c732007-10-06 15:11:06 +0000562LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000563 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000564LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000565 LLVMValueRef *ConstantVals, unsigned Length);
566LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000567 LLVMBool Packed);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000568LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000569
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000570/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000571LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000572LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000573LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
574LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000575LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
576LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000577LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000578LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
579LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000580LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000581LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000582LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000583LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000584LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
585LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000586LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000587LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000588LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
589LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000590LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000591LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
592LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000593LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000594LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
595LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
596LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
597LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
598LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
599LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
600LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
601LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
602 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
604 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
605LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
606LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
607LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
609 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000610LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
611 LLVMValueRef *ConstantIndices,
612 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000613LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
614LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
615LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
616LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
617LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
618LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
619LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
620LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
621LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
622LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
623LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
624LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000625LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
626 LLVMTypeRef ToType);
627LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
628 LLVMTypeRef ToType);
629LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
630 LLVMTypeRef ToType);
631LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
632 LLVMTypeRef ToType);
633LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000634 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000635LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000636LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
637 LLVMValueRef ConstantIfTrue,
638 LLVMValueRef ConstantIfFalse);
639LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
640 LLVMValueRef IndexConstant);
641LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
642 LLVMValueRef ElementValueConstant,
643 LLVMValueRef IndexConstant);
644LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
645 LLVMValueRef VectorBConstant,
646 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000647LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
648 unsigned NumIdx);
649LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
650 LLVMValueRef ElementValueConstant,
651 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000652LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000653 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000654 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000655LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000656
Gordon Henriksen76a03742007-09-18 03:18:57 +0000657/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000658LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000659LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000660LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
661void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
662const char *LLVMGetSection(LLVMValueRef Global);
663void LLVMSetSection(LLVMValueRef Global, const char *Section);
664LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
665void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
666unsigned LLVMGetAlignment(LLVMValueRef Global);
667void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
668
669/* Operations on global variables */
670LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000671LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
672 const char *Name,
673 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000674LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000675LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
676LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
677LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
678LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000679void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000680LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
681void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000682LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
683void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
684LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
685void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000686
Chris Lattner3d1f5522008-12-17 21:39:50 +0000687/* Operations on aliases */
688LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
689 const char *Name);
690
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000691/* Operations on functions */
692LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
693 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000694LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000695LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
696LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
697LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
698LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000699void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000700unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
701unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
702void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000703const char *LLVMGetGC(LLVMValueRef Fn);
704void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000705void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000706LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000707void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000708
Gordon Henriksen265f7802008-03-19 01:11:35 +0000709/* Operations on parameters */
710unsigned LLVMCountParams(LLVMValueRef Fn);
711void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
712LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
713LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000714LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
715LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
716LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
717LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000718void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
719void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000720LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000721void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000722
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000723/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000724LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000725LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000726LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000727LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000728unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
729void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000730LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
731LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
732LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
733LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000734LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000735
736LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
737 LLVMValueRef Fn,
738 const char *Name);
739LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
740 LLVMBasicBlockRef BB,
741 const char *Name);
742
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000743LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
744LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
745 const char *Name);
746void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
747
Duncan Sandsb1d61aa2010-07-19 15:31:07 +0000748void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
749void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
750
Gordon Henriksen265f7802008-03-19 01:11:35 +0000751/* Operations on instructions */
752LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000753LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
754LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
755LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
756LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000757
Gordon Henriksen1158c532007-12-29 20:45:00 +0000758/* Operations on call sites */
759void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
760unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000761void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
762void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
763 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000764void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
765 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000766
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000767/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000768LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
769void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000770
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000771/* Operations on phi nodes */
772void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
773 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
774unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
775LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
776LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000777
778/*===-- Instruction builders ----------------------------------------------===*/
779
780/* An instruction builder represents a point within a basic block, and is the
781 * exclusive means of building instructions using the C interface.
782 */
783
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000784LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000785LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000786void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
787 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000788void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
789void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000790LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000791void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
792void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000793void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
794 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000795void LLVMDisposeBuilder(LLVMBuilderRef Builder);
796
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000797/* Metadata */
798void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
799LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
800void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
801
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000802/* Terminators */
803LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
804LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000805LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000806 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000807LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
808LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
809 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
810LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
811 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000812LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
813 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000814LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
815 LLVMValueRef *Args, unsigned NumArgs,
816 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
817 const char *Name);
818LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
819LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
820
Gordon Henriksen097102c2008-01-01 05:50:53 +0000821/* Add a case to the switch instruction */
822void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
823 LLVMBasicBlockRef Dest);
824
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000825/* Add a destination to the indirectbr instruction */
826void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
827
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000828/* Arithmetic */
829LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
830 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000831LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
832 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000833LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
834 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000835LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
836 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000837LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
838 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000839LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
840 const char *Name);
841LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
842 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000843LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
844 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000845LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
846 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000847LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
848 const char *Name);
849LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
850 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000851LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
852 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000853LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
854 const char *Name);
855LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
856 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000857LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
858 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000859LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
860 const char *Name);
861LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
862 const char *Name);
863LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
864 const char *Name);
865LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
866 const char *Name);
867LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
868 const char *Name);
869LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
870 const char *Name);
871LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
872 const char *Name);
873LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
874 const char *Name);
875LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
876 const char *Name);
877LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
878 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000879LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
880 LLVMValueRef LHS, LLVMValueRef RHS,
881 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000882LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000883LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
884 const char *Name);
885LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
886 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000887LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000888LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
889
890/* Memory */
891LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
892LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
893 LLVMValueRef Val, const char *Name);
894LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
895LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
896 LLVMValueRef Val, const char *Name);
897LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
898LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
899 const char *Name);
900LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
901LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
902 LLVMValueRef *Indices, unsigned NumIndices,
903 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000904LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
905 LLVMValueRef *Indices, unsigned NumIndices,
906 const char *Name);
907LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
908 unsigned Idx, const char *Name);
909LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
910 const char *Name);
911LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
912 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000913
914/* Casts */
915LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
916 LLVMTypeRef DestTy, const char *Name);
917LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
918 LLVMTypeRef DestTy, const char *Name);
919LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
920 LLVMTypeRef DestTy, const char *Name);
921LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
922 LLVMTypeRef DestTy, const char *Name);
923LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
924 LLVMTypeRef DestTy, const char *Name);
925LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
926 LLVMTypeRef DestTy, const char *Name);
927LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
928 LLVMTypeRef DestTy, const char *Name);
929LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
930 LLVMTypeRef DestTy, const char *Name);
931LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
932 LLVMTypeRef DestTy, const char *Name);
933LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
934 LLVMTypeRef DestTy, const char *Name);
935LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
936 LLVMTypeRef DestTy, const char *Name);
937LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
938 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000939LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
940 LLVMTypeRef DestTy, const char *Name);
941LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
942 LLVMTypeRef DestTy, const char *Name);
943LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
944 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000945LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
946 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000947LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
948 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000949LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000950 LLVMTypeRef DestTy, const char *Name);
951LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
952 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000953
954/* Comparisons */
955LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
956 LLVMValueRef LHS, LLVMValueRef RHS,
957 const char *Name);
958LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
959 LLVMValueRef LHS, LLVMValueRef RHS,
960 const char *Name);
961
962/* Miscellaneous instructions */
963LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
964LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
965 LLVMValueRef *Args, unsigned NumArgs,
966 const char *Name);
967LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
968 LLVMValueRef Then, LLVMValueRef Else,
969 const char *Name);
970LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
971 const char *Name);
972LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
973 LLVMValueRef Index, const char *Name);
974LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
975 LLVMValueRef EltVal, LLVMValueRef Index,
976 const char *Name);
977LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
978 LLVMValueRef V2, LLVMValueRef Mask,
979 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000980LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
981 unsigned Index, const char *Name);
982LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
983 LLVMValueRef EltVal, unsigned Index,
984 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000985
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000986LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
987 const char *Name);
988LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
989 const char *Name);
990LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
991 LLVMValueRef RHS, const char *Name);
992
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000993
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000994/*===-- Module providers --------------------------------------------------===*/
995
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000996/* Changes the type of M so it can be passed to FunctionPassManagers and the
997 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000998 */
999LLVMModuleProviderRef
1000LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1001
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001002/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001003 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001004void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001005
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001006
1007/*===-- Memory buffers ----------------------------------------------------===*/
1008
Chris Lattner25963c62010-01-09 22:27:07 +00001009LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1010 LLVMMemoryBufferRef *OutMemBuf,
1011 char **OutMessage);
1012LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1013 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001014void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1015
Owen Anderson4698c5d2010-10-07 17:55:47 +00001016/*===-- Pass Registry -----------------------------------------------------===*/
1017
1018/** Return the global pass registry, for use with initialization functions.
1019 See llvm::PassRegistry::getPassRegistry. */
1020LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001021
1022/*===-- Pass Managers -----------------------------------------------------===*/
1023
1024/** Constructs a new whole-module pass pipeline. This type of pipeline is
1025 suitable for link-time optimization and whole-module transformations.
1026 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001027LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001028
1029/** Constructs a new function-by-function pass pipeline over the module
1030 provider. It does not take ownership of the module provider. This type of
1031 pipeline is suitable for code generation and JIT compilation tasks.
1032 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001033LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1034
1035/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001036LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1037
1038/** Initializes, executes on the provided module, and finalizes all of the
1039 passes scheduled in the pass manager. Returns 1 if any of the passes
1040 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001041LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001042
1043/** Initializes all of the function passes scheduled in the function pass
1044 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1045 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001046LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001047
1048/** Executes all of the function passes scheduled in the function pass manager
1049 on the provided function. Returns 1 if any of the passes modified the
1050 function, false otherwise.
1051 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001052LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001053
1054/** Finalizes all of the function passes scheduled in in the function pass
1055 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1056 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001057LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001058
1059/** Frees the memory of a pass pipeline. For function pipelines, does not free
1060 the module provider.
1061 See llvm::PassManagerBase::~PassManagerBase. */
1062void LLVMDisposePassManager(LLVMPassManagerRef PM);
1063
1064
Gordon Henriksen76a03742007-09-18 03:18:57 +00001065#ifdef __cplusplus
1066}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001067
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001068namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001069 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001070 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001071
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001072 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1073 inline ty *unwrap(ref P) { \
1074 return reinterpret_cast<ty*>(P); \
1075 } \
1076 \
1077 inline ref wrap(const ty *P) { \
1078 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1079 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001080
Gordon Henriksen878114b2008-03-16 04:20:44 +00001081 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1082 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1083 \
1084 template<typename T> \
1085 inline T *unwrap(ref P) { \
1086 return cast<T>(unwrap(P)); \
1087 }
1088
1089 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1090 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1091 \
1092 template<typename T> \
1093 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001094 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001095 assert(Q && "Invalid cast!"); \
1096 return Q; \
1097 }
1098
1099 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1100 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001101 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1102 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001103 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001104 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001105 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001106 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001107 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Owen Anderson4698c5d2010-10-07 17:55:47 +00001108 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001109 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1110 * Module.
1111 */
1112 inline Module *unwrap(LLVMModuleProviderRef MP) {
1113 return reinterpret_cast<Module*>(MP);
1114 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001115
Gordon Henriksen878114b2008-03-16 04:20:44 +00001116 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1117 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001118 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001119
1120 /* Specialized opaque context conversions.
1121 */
1122 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1123 return reinterpret_cast<LLVMContext**>(Tys);
1124 }
1125
1126 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1127 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1128 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001129
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001130 /* Specialized opaque type conversions.
1131 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001132 inline Type **unwrap(LLVMTypeRef* Tys) {
1133 return reinterpret_cast<Type**>(Tys);
1134 }
1135
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001136 inline LLVMTypeRef *wrap(const Type **Tys) {
1137 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1138 }
1139
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001140 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001141 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001142 inline Value **unwrap(LLVMValueRef *Vals) {
1143 return reinterpret_cast<Value**>(Vals);
1144 }
1145
1146 template<typename T>
1147 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1148 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001149 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001150 cast<T>(*I);
1151 #endif
Hans Wennborg8f7edbf2011-06-04 16:00:19 +00001152 (void)Length;
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001153 return reinterpret_cast<T**>(Vals);
1154 }
1155
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001156 inline LLVMValueRef *wrap(const Value **Vals) {
1157 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1158 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001159}
1160
1161#endif /* !defined(__cplusplus) */
1162
1163#endif /* !defined(LLVM_C_CORE_H) */