blob: e3dce581eecbec95f4754161e9830c8bff4cc053 [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);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000397
398/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000399LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000400LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000401LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000402
403LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
404unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000405unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000406unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
407
408/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000409LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
410LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000411LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000412
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000413LLVMTypeRef LLVMVoidType(void);
414LLVMTypeRef LLVMLabelType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000415LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000416
Gordon Henriksen76a03742007-09-18 03:18:57 +0000417/*===-- Values ------------------------------------------------------------===*/
418
419/* The bulk of LLVM's object model consists of values, which comprise a very
420 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000421 */
422
Gordon Henriksen29e38942008-12-19 18:39:45 +0000423#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
424 macro(Argument) \
425 macro(BasicBlock) \
426 macro(InlineAsm) \
427 macro(User) \
428 macro(Constant) \
429 macro(ConstantAggregateZero) \
430 macro(ConstantArray) \
431 macro(ConstantExpr) \
432 macro(ConstantFP) \
433 macro(ConstantInt) \
434 macro(ConstantPointerNull) \
435 macro(ConstantStruct) \
436 macro(ConstantVector) \
437 macro(GlobalValue) \
438 macro(Function) \
439 macro(GlobalAlias) \
440 macro(GlobalVariable) \
441 macro(UndefValue) \
442 macro(Instruction) \
443 macro(BinaryOperator) \
444 macro(CallInst) \
445 macro(IntrinsicInst) \
446 macro(DbgInfoIntrinsic) \
447 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000448 macro(EHSelectorInst) \
449 macro(MemIntrinsic) \
450 macro(MemCpyInst) \
451 macro(MemMoveInst) \
452 macro(MemSetInst) \
453 macro(CmpInst) \
454 macro(FCmpInst) \
455 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000456 macro(ExtractElementInst) \
457 macro(GetElementPtrInst) \
458 macro(InsertElementInst) \
459 macro(InsertValueInst) \
460 macro(PHINode) \
461 macro(SelectInst) \
462 macro(ShuffleVectorInst) \
463 macro(StoreInst) \
464 macro(TerminatorInst) \
465 macro(BranchInst) \
466 macro(InvokeInst) \
467 macro(ReturnInst) \
468 macro(SwitchInst) \
469 macro(UnreachableInst) \
470 macro(UnwindInst) \
471 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000472 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000473 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000474 macro(BitCastInst) \
475 macro(FPExtInst) \
476 macro(FPToSIInst) \
477 macro(FPToUIInst) \
478 macro(FPTruncInst) \
479 macro(IntToPtrInst) \
480 macro(PtrToIntInst) \
481 macro(SExtInst) \
482 macro(SIToFPInst) \
483 macro(TruncInst) \
484 macro(UIToFPInst) \
485 macro(ZExtInst) \
486 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000487 macro(LoadInst) \
488 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000489
Gordon Henriksen76a03742007-09-18 03:18:57 +0000490/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000491LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000492const char *LLVMGetValueName(LLVMValueRef Val);
493void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000494void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000495void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000496int LLVMHasMetadata(LLVMValueRef Val);
497LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
498void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000499
Gordon Henriksen29e38942008-12-19 18:39:45 +0000500/* Conversion functions. Return the input value if it is an instance of the
501 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
502#define LLVM_DECLARE_VALUE_CAST(name) \
503 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
504LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
505
Chris Lattner40cf28d2009-10-12 04:01:02 +0000506/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000507LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
508LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
509LLVMValueRef LLVMGetUser(LLVMUseRef U);
510LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000511
512/* Operations on Users */
513LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Erick Tryzelaarb4d48702010-08-20 14:51:22 +0000514void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
515int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000516
Gordon Henriksen76a03742007-09-18 03:18:57 +0000517/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000518LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
519LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000520LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000521LLVMBool LLVMIsConstant(LLVMValueRef Val);
522LLVMBool LLVMIsNull(LLVMValueRef Val);
523LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000524LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000525
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000526/* Operations on metadata */
527LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
528 unsigned SLen);
529LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
530LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
531 unsigned Count);
532LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
533
Gordon Henriksen76a03742007-09-18 03:18:57 +0000534/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000535LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000536 LLVMBool SignExtend);
Chris Lattner4329e072010-11-23 02:47:22 +0000537LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
538 unsigned NumWords,
539 const uint64_t Words[]);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000540LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
541 uint8_t Radix);
542LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
543 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000544LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000545LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000546LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
547 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000548unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
549long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000550
Gordon Henriksen76a03742007-09-18 03:18:57 +0000551
552/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000553LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000554 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000555LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
556 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000557 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000558
Gordon Henriksen1046c732007-10-06 15:11:06 +0000559LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000560 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000561LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000562 LLVMValueRef *ConstantVals, unsigned Length);
563LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000564 LLVMBool Packed);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000565LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000566
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000567/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000568LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000569LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000570LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
571LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000572LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
573LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000574LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000575LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
576LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000577LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000578LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000579LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000580LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000581LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
582LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000583LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000584LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000585LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
586LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000587LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000588LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
589LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000590LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000591LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
592LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
593LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
594LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
595LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
596LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
597LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
598LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
599 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
600LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
601 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
602LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
604LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
605LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
606 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000607LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
608 LLVMValueRef *ConstantIndices,
609 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000610LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
611LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
612LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
613LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
614LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
615LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
616LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
617LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
618LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
619LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
620LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
621LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000622LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
623 LLVMTypeRef ToType);
624LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
625 LLVMTypeRef ToType);
626LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
627 LLVMTypeRef ToType);
628LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
629 LLVMTypeRef ToType);
630LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000631 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000632LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000633LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
634 LLVMValueRef ConstantIfTrue,
635 LLVMValueRef ConstantIfFalse);
636LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
637 LLVMValueRef IndexConstant);
638LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
639 LLVMValueRef ElementValueConstant,
640 LLVMValueRef IndexConstant);
641LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
642 LLVMValueRef VectorBConstant,
643 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000644LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
645 unsigned NumIdx);
646LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
647 LLVMValueRef ElementValueConstant,
648 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000649LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000650 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000651 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000652LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000653
Gordon Henriksen76a03742007-09-18 03:18:57 +0000654/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000655LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000656LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000657LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
658void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
659const char *LLVMGetSection(LLVMValueRef Global);
660void LLVMSetSection(LLVMValueRef Global, const char *Section);
661LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
662void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
663unsigned LLVMGetAlignment(LLVMValueRef Global);
664void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
665
666/* Operations on global variables */
667LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000668LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
669 const char *Name,
670 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000671LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000672LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
673LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
674LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
675LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000676void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000677LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
678void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000679LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
680void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
681LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
682void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000683
Chris Lattner3d1f5522008-12-17 21:39:50 +0000684/* Operations on aliases */
685LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
686 const char *Name);
687
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000688/* Operations on functions */
689LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
690 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000691LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000692LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
693LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
694LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
695LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000696void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000697unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
698unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
699void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000700const char *LLVMGetGC(LLVMValueRef Fn);
701void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000702void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000703LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000704void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000705
Gordon Henriksen265f7802008-03-19 01:11:35 +0000706/* Operations on parameters */
707unsigned LLVMCountParams(LLVMValueRef Fn);
708void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
709LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
710LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000711LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
712LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
713LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
714LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000715void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
716void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000717LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000718void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000719
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000720/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000721LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000722LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000723LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000724LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000725unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
726void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000727LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
728LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
729LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
730LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000731LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000732
733LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
734 LLVMValueRef Fn,
735 const char *Name);
736LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
737 LLVMBasicBlockRef BB,
738 const char *Name);
739
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000740LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
741LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
742 const char *Name);
743void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
744
Duncan Sandsb1d61aa2010-07-19 15:31:07 +0000745void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
746void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
747
Gordon Henriksen265f7802008-03-19 01:11:35 +0000748/* Operations on instructions */
749LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000750LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
751LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
752LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
753LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000754
Gordon Henriksen1158c532007-12-29 20:45:00 +0000755/* Operations on call sites */
756void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
757unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000758void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
759void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
760 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000761void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
762 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000763
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000764/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000765LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
766void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000767
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000768/* Operations on phi nodes */
769void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
770 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
771unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
772LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
773LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000774
775/*===-- Instruction builders ----------------------------------------------===*/
776
777/* An instruction builder represents a point within a basic block, and is the
778 * exclusive means of building instructions using the C interface.
779 */
780
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000781LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000782LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000783void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
784 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000785void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
786void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000787LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000788void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
789void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000790void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
791 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000792void LLVMDisposeBuilder(LLVMBuilderRef Builder);
793
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000794/* Metadata */
795void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
796LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
797void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
798
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000799/* Terminators */
800LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
801LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000802LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000803 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000804LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
805LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
806 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
807LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
808 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000809LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
810 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000811LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
812 LLVMValueRef *Args, unsigned NumArgs,
813 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
814 const char *Name);
815LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
816LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
817
Gordon Henriksen097102c2008-01-01 05:50:53 +0000818/* Add a case to the switch instruction */
819void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
820 LLVMBasicBlockRef Dest);
821
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000822/* Add a destination to the indirectbr instruction */
823void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
824
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000825/* Arithmetic */
826LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
827 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000828LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
829 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000830LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
831 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000832LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
833 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000834LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
835 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000836LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
837 const char *Name);
838LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
839 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000840LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
841 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000842LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
843 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000844LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
845 const char *Name);
846LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
847 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000848LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
849 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000850LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
851 const char *Name);
852LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
853 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000854LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
855 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000856LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
857 const char *Name);
858LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
859 const char *Name);
860LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
861 const char *Name);
862LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
863 const char *Name);
864LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
865 const char *Name);
866LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
867 const char *Name);
868LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
869 const char *Name);
870LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
871 const char *Name);
872LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
873 const char *Name);
874LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
875 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000876LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
877 LLVMValueRef LHS, LLVMValueRef RHS,
878 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000879LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000880LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
881 const char *Name);
882LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
883 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000884LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000885LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
886
887/* Memory */
888LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
889LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
890 LLVMValueRef Val, const char *Name);
891LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
892LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
893 LLVMValueRef Val, const char *Name);
894LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
895LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
896 const char *Name);
897LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
898LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
899 LLVMValueRef *Indices, unsigned NumIndices,
900 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000901LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
902 LLVMValueRef *Indices, unsigned NumIndices,
903 const char *Name);
904LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
905 unsigned Idx, const char *Name);
906LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
907 const char *Name);
908LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
909 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000910
911/* Casts */
912LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
913 LLVMTypeRef DestTy, const char *Name);
914LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
915 LLVMTypeRef DestTy, const char *Name);
916LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
917 LLVMTypeRef DestTy, const char *Name);
918LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
919 LLVMTypeRef DestTy, const char *Name);
920LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
921 LLVMTypeRef DestTy, const char *Name);
922LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
923 LLVMTypeRef DestTy, const char *Name);
924LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
925 LLVMTypeRef DestTy, const char *Name);
926LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
927 LLVMTypeRef DestTy, const char *Name);
928LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
929 LLVMTypeRef DestTy, const char *Name);
930LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
931 LLVMTypeRef DestTy, const char *Name);
932LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
933 LLVMTypeRef DestTy, const char *Name);
934LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
935 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000936LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
937 LLVMTypeRef DestTy, const char *Name);
938LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
939 LLVMTypeRef DestTy, const char *Name);
940LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
941 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000942LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
943 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000944LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
945 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000946LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000947 LLVMTypeRef DestTy, const char *Name);
948LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
949 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000950
951/* Comparisons */
952LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
953 LLVMValueRef LHS, LLVMValueRef RHS,
954 const char *Name);
955LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
956 LLVMValueRef LHS, LLVMValueRef RHS,
957 const char *Name);
958
959/* Miscellaneous instructions */
960LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
961LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
962 LLVMValueRef *Args, unsigned NumArgs,
963 const char *Name);
964LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
965 LLVMValueRef Then, LLVMValueRef Else,
966 const char *Name);
967LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
968 const char *Name);
969LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
970 LLVMValueRef Index, const char *Name);
971LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
972 LLVMValueRef EltVal, LLVMValueRef Index,
973 const char *Name);
974LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
975 LLVMValueRef V2, LLVMValueRef Mask,
976 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000977LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
978 unsigned Index, const char *Name);
979LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
980 LLVMValueRef EltVal, unsigned Index,
981 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000982
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000983LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
984 const char *Name);
985LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
986 const char *Name);
987LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
988 LLVMValueRef RHS, const char *Name);
989
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000990
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000991/*===-- Module providers --------------------------------------------------===*/
992
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000993/* Changes the type of M so it can be passed to FunctionPassManagers and the
994 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000995 */
996LLVMModuleProviderRef
997LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
998
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000999/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001000 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001001void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001002
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001003
1004/*===-- Memory buffers ----------------------------------------------------===*/
1005
Chris Lattner25963c62010-01-09 22:27:07 +00001006LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1007 LLVMMemoryBufferRef *OutMemBuf,
1008 char **OutMessage);
1009LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1010 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001011void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1012
Owen Anderson4698c5d2010-10-07 17:55:47 +00001013/*===-- Pass Registry -----------------------------------------------------===*/
1014
1015/** Return the global pass registry, for use with initialization functions.
1016 See llvm::PassRegistry::getPassRegistry. */
1017LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001018
1019/*===-- Pass Managers -----------------------------------------------------===*/
1020
1021/** Constructs a new whole-module pass pipeline. This type of pipeline is
1022 suitable for link-time optimization and whole-module transformations.
1023 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001024LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001025
1026/** Constructs a new function-by-function pass pipeline over the module
1027 provider. It does not take ownership of the module provider. This type of
1028 pipeline is suitable for code generation and JIT compilation tasks.
1029 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001030LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1031
1032/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001033LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1034
1035/** Initializes, executes on the provided module, and finalizes all of the
1036 passes scheduled in the pass manager. Returns 1 if any of the passes
1037 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001038LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001039
1040/** Initializes all of the function passes scheduled in the function pass
1041 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1042 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001043LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001044
1045/** Executes all of the function passes scheduled in the function pass manager
1046 on the provided function. Returns 1 if any of the passes modified the
1047 function, false otherwise.
1048 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001049LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001050
1051/** Finalizes all of the function passes scheduled in in the function pass
1052 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1053 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001054LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001055
1056/** Frees the memory of a pass pipeline. For function pipelines, does not free
1057 the module provider.
1058 See llvm::PassManagerBase::~PassManagerBase. */
1059void LLVMDisposePassManager(LLVMPassManagerRef PM);
1060
1061
Gordon Henriksen76a03742007-09-18 03:18:57 +00001062#ifdef __cplusplus
1063}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001064
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001065namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001066 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001067 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001068
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001069 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1070 inline ty *unwrap(ref P) { \
1071 return reinterpret_cast<ty*>(P); \
1072 } \
1073 \
1074 inline ref wrap(const ty *P) { \
1075 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1076 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001077
Gordon Henriksen878114b2008-03-16 04:20:44 +00001078 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1079 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1080 \
1081 template<typename T> \
1082 inline T *unwrap(ref P) { \
1083 return cast<T>(unwrap(P)); \
1084 }
1085
1086 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1087 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1088 \
1089 template<typename T> \
1090 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001091 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001092 assert(Q && "Invalid cast!"); \
1093 return Q; \
1094 }
1095
1096 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1097 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001098 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1099 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001100 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001101 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001102 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001103 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001104 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Owen Anderson4698c5d2010-10-07 17:55:47 +00001105 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001106 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1107 * Module.
1108 */
1109 inline Module *unwrap(LLVMModuleProviderRef MP) {
1110 return reinterpret_cast<Module*>(MP);
1111 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001112
Gordon Henriksen878114b2008-03-16 04:20:44 +00001113 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1114 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001115 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001116
1117 /* Specialized opaque context conversions.
1118 */
1119 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1120 return reinterpret_cast<LLVMContext**>(Tys);
1121 }
1122
1123 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1124 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1125 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001126
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001127 /* Specialized opaque type conversions.
1128 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001129 inline Type **unwrap(LLVMTypeRef* Tys) {
1130 return reinterpret_cast<Type**>(Tys);
1131 }
1132
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001133 inline LLVMTypeRef *wrap(const Type **Tys) {
1134 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1135 }
1136
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001137 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001138 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001139 inline Value **unwrap(LLVMValueRef *Vals) {
1140 return reinterpret_cast<Value**>(Vals);
1141 }
1142
1143 template<typename T>
1144 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1145 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001146 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001147 cast<T>(*I);
1148 #endif
Hans Wennborg8f7edbf2011-06-04 16:00:19 +00001149 (void)Length;
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001150 return reinterpret_cast<T**>(Vals);
1151 }
1152
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001153 inline LLVMValueRef *wrap(const Value **Vals) {
1154 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1155 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001156}
1157
1158#endif /* !defined(__cplusplus) */
1159
1160#endif /* !defined(LLVM_C_CORE_H) */