blob: 3d374b062ce9acd80b9c55f00f115476053bab3f [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,
Bill Wendling46ffaa92011-08-02 06:20:17 +0000128 /* removed 6 due to API changes */
Bill Wendling2641d132011-07-27 21:00:28 +0000129 LLVMUnreachable = 7,
Bill Wendling07d6d762010-02-15 20:50:51 +0000130
Bill Wendlingda52cec2010-02-15 20:53:17 +0000131 /* Standard Binary Operators */
Bill Wendling2641d132011-07-27 21:00:28 +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,
Bill Wendling07d6d762010-02-15 20:50:51 +0000144
Bill Wendlingda52cec2010-02-15 20:53:17 +0000145 /* Logical Operators */
Bill Wendling2641d132011-07-27 21:00:28 +0000146 LLVMShl = 20,
147 LLVMLShr = 21,
148 LLVMAShr = 22,
149 LLVMAnd = 23,
150 LLVMOr = 24,
151 LLVMXor = 25,
Bill Wendling07d6d762010-02-15 20:50:51 +0000152
Bill Wendlingda52cec2010-02-15 20:53:17 +0000153 /* Memory Operators */
Bill Wendling2641d132011-07-27 21:00:28 +0000154 LLVMAlloca = 26,
155 LLVMLoad = 27,
156 LLVMStore = 28,
157 LLVMGetElementPtr = 29,
Bill Wendling07d6d762010-02-15 20:50:51 +0000158
Bill Wendlingda52cec2010-02-15 20:53:17 +0000159 /* Cast Operators */
Bill Wendling2641d132011-07-27 21:00:28 +0000160 LLVMTrunc = 30,
161 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,
Bill Wendling07d6d762010-02-15 20:50:51 +0000172
Bill Wendlingda52cec2010-02-15 20:53:17 +0000173 /* Other Operators */
Bill Wendling2641d132011-07-27 21:00:28 +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 Wendling2641d132011-07-27 21:00:28 +0000181 LLVMVAArg = 49,
182 LLVMExtractElement = 50,
183 LLVMInsertElement = 51,
184 LLVMShuffleVector = 52,
185 LLVMExtractValue = 53,
186 LLVMInsertValue = 54,
Eli Friedman4fc946c2011-07-27 18:59:19 +0000187
188 /* Atomic operators */
Bill Wendling2641d132011-07-27 21:00:28 +0000189 LLVMFence = 55,
Eli Friedmanc9a551e2011-07-28 21:48:00 +0000190 LLVMAtomicCmpXchg = 56,
Bill Wendlingf891bf82011-07-31 06:30:59 +0000191 LLVMAtomicRMW = 57,
192
193 /* Exception Handling Operators */
Bill Wendlingfae14752011-08-12 20:24:12 +0000194 LLVMResume = 58,
195 LLVMLandingPad = 59
Bill Wendling2641d132011-07-27 21:00:28 +0000196
Chris Lattner40cf28d2009-10-12 04:01:02 +0000197} LLVMOpcode;
198
199typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000200 LLVMVoidTypeKind, /**< type with no size */
201 LLVMFloatTypeKind, /**< 32 bit floating point type */
202 LLVMDoubleTypeKind, /**< 64 bit floating point type */
203 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
204 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
205 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
206 LLVMLabelTypeKind, /**< Labels */
207 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
208 LLVMFunctionTypeKind, /**< Functions */
209 LLVMStructTypeKind, /**< Structures */
210 LLVMArrayTypeKind, /**< Arrays */
211 LLVMPointerTypeKind, /**< Pointers */
Chris Lattnerdac44ec2009-07-15 22:00:31 +0000212 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
Dale Johannesenbaa5d042010-09-10 20:55:01 +0000213 LLVMMetadataTypeKind, /**< Metadata */
214 LLVMX86_MMXTypeKind /**< X86 MMX */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000215} LLVMTypeKind;
216
217typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000218 LLVMExternalLinkage, /**< Externally visible function */
Chris Lattner2dba0f02009-04-13 06:25:37 +0000219 LLVMAvailableExternallyLinkage,
Duncan Sands12da8ce2009-03-07 15:45:40 +0000220 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
221 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
222 equivalent. */
223 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
224 LLVMWeakODRLinkage, /**< Same, but only replaced by something
225 equivalent. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000226 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
227 LLVMInternalLinkage, /**< Rename collisions when linking (static
228 functions) */
Duncan Sands12da8ce2009-03-07 15:45:40 +0000229 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000230 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
231 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
Duncan Sandse2881052009-03-11 08:08:06 +0000232 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000233 LLVMGhostLinkage, /**< Obsolete */
Bill Wendling002b1672009-07-20 18:22:52 +0000234 LLVMCommonLinkage, /**< Tentative definitions */
Bill Wendling03bcd6e2010-07-01 21:55:59 +0000235 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
Bill Wendling578ee402010-08-20 22:05:50 +0000236 LLVMLinkerPrivateWeakLinkage, /**< Like LinkerPrivate, but is weak. */
237 LLVMLinkerPrivateWeakDefAutoLinkage /**< Like LinkerPrivateWeak, but possibly
238 hidden. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000239} LLVMLinkage;
240
241typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000242 LLVMDefaultVisibility, /**< The GV is visible */
243 LLVMHiddenVisibility, /**< The GV is hidden */
244 LLVMProtectedVisibility /**< The GV is protected */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000245} LLVMVisibility;
246
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000247typedef enum {
248 LLVMCCallConv = 0,
249 LLVMFastCallConv = 8,
250 LLVMColdCallConv = 9,
251 LLVMX86StdcallCallConv = 64,
252 LLVMX86FastcallCallConv = 65
253} LLVMCallConv;
254
255typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000256 LLVMIntEQ = 32, /**< equal */
257 LLVMIntNE, /**< not equal */
258 LLVMIntUGT, /**< unsigned greater than */
259 LLVMIntUGE, /**< unsigned greater or equal */
260 LLVMIntULT, /**< unsigned less than */
261 LLVMIntULE, /**< unsigned less or equal */
262 LLVMIntSGT, /**< signed greater than */
263 LLVMIntSGE, /**< signed greater or equal */
264 LLVMIntSLT, /**< signed less than */
265 LLVMIntSLE /**< signed less or equal */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000266} LLVMIntPredicate;
267
268typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000269 LLVMRealPredicateFalse, /**< Always false (always folded) */
270 LLVMRealOEQ, /**< True if ordered and equal */
271 LLVMRealOGT, /**< True if ordered and greater than */
272 LLVMRealOGE, /**< True if ordered and greater than or equal */
273 LLVMRealOLT, /**< True if ordered and less than */
274 LLVMRealOLE, /**< True if ordered and less than or equal */
275 LLVMRealONE, /**< True if ordered and operands are unequal */
276 LLVMRealORD, /**< True if ordered (no nans) */
277 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
278 LLVMRealUEQ, /**< True if unordered or equal */
279 LLVMRealUGT, /**< True if unordered or greater than */
280 LLVMRealUGE, /**< True if unordered, greater than, or equal */
281 LLVMRealULT, /**< True if unordered or less than */
282 LLVMRealULE, /**< True if unordered, less than, or equal */
283 LLVMRealUNE, /**< True if unordered or not equal */
284 LLVMRealPredicateTrue /**< Always true (always folded) */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000285} LLVMRealPredicate;
286
Bill Wendlingfae14752011-08-12 20:24:12 +0000287typedef enum {
288 LLVMLandingPadCatch, /**< A catch clause */
289 LLVMLandingPadFilter /**< A filter clause */
290} LLVMLandingPadClauseTy;
291
Nick Lewycky0db26542011-05-15 07:20:34 +0000292void LLVMInitializeCore(LLVMPassRegistryRef R);
293
Gordon Henriksen76a03742007-09-18 03:18:57 +0000294
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000295/*===-- Error handling ----------------------------------------------------===*/
296
297void LLVMDisposeMessage(char *Message);
298
299
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000300/*===-- Contexts ----------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000301
Owen Anderson6773d382009-07-01 16:58:40 +0000302/* Create and destroy contexts. */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000303LLVMContextRef LLVMContextCreate(void);
304LLVMContextRef LLVMGetGlobalContext(void);
Owen Anderson6773d382009-07-01 16:58:40 +0000305void LLVMContextDispose(LLVMContextRef C);
306
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000307unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
308 unsigned SLen);
309unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
310
311/*===-- Modules -----------------------------------------------------------===*/
312
Gordon Henriksen76a03742007-09-18 03:18:57 +0000313/* Create and destroy modules. */
Gordon Henriksena49d4352008-03-07 19:13:06 +0000314/** See llvm::Module::Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000315LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Owen Anderson31d44e42009-07-02 07:17:57 +0000316LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
317 LLVMContextRef C);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000318
319/** See llvm::Module::~Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000320void LLVMDisposeModule(LLVMModuleRef M);
321
Gordon Henriksena49d4352008-03-07 19:13:06 +0000322/** Data layout. See Module::getDataLayout. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000323const char *LLVMGetDataLayout(LLVMModuleRef M);
324void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
325
Gordon Henriksena49d4352008-03-07 19:13:06 +0000326/** Target triple. See Module::getTargetTriple. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000327const char *LLVMGetTarget(LLVMModuleRef M);
328void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
329
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000330/** See Module::dump. */
331void LLVMDumpModule(LLVMModuleRef M);
332
Chris Lattner26941452010-04-10 17:52:58 +0000333/** See Module::setModuleInlineAsm. */
334void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000335
Chris Lattnera7e04b02010-11-28 20:03:44 +0000336/** See Module::getContext. */
337LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
338
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000339/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000340
341/* LLVM types conform to the following hierarchy:
342 *
343 * types:
344 * integer type
345 * real type
346 * function type
347 * sequence types:
348 * array type
349 * pointer type
350 * vector type
351 * void type
352 * label type
353 * opaque type
354 */
355
Gordon Henriksena49d4352008-03-07 19:13:06 +0000356/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000357LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000358
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000359/** See llvm::LLVMType::getContext. */
360LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
361
Gordon Henriksen76a03742007-09-18 03:18:57 +0000362/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000363LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
364LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
365LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
366LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
367LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
368LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
369
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000370LLVMTypeRef LLVMInt1Type(void);
371LLVMTypeRef LLVMInt8Type(void);
372LLVMTypeRef LLVMInt16Type(void);
373LLVMTypeRef LLVMInt32Type(void);
374LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000375LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000376unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000377
378/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000379LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
380LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
381LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
382LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
383LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
384
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000385LLVMTypeRef LLVMFloatType(void);
386LLVMTypeRef LLVMDoubleType(void);
387LLVMTypeRef LLVMX86FP80Type(void);
388LLVMTypeRef LLVMFP128Type(void);
389LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000390
391/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000392LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
393 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000394 LLVMBool IsVarArg);
395LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000396LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
397unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
398void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000399
400/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000401LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000402 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000403LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000404 LLVMBool Packed);
Chris Lattnere71ccde2011-07-14 05:53:17 +0000405LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
Torok Edwin0d5f6ae2011-10-06 12:12:50 +0000406const char *LLVMGetStructName(LLVMTypeRef Ty);
Chris Lattnere71ccde2011-07-14 05:53:17 +0000407void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
408 unsigned ElementCount, LLVMBool Packed);
409
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000410unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000411void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000412LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Chris Lattner17cf05b2011-07-14 16:20:28 +0000413LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
414
415LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000416
417/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000418LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000419LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000420LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000421
422LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
423unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000424unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000425unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
426
427/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000428LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
429LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000430LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000431
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000432LLVMTypeRef LLVMVoidType(void);
433LLVMTypeRef LLVMLabelType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000434LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000435
Gordon Henriksen76a03742007-09-18 03:18:57 +0000436/*===-- Values ------------------------------------------------------------===*/
437
438/* The bulk of LLVM's object model consists of values, which comprise a very
439 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000440 */
441
Gordon Henriksen29e38942008-12-19 18:39:45 +0000442#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
443 macro(Argument) \
444 macro(BasicBlock) \
445 macro(InlineAsm) \
446 macro(User) \
447 macro(Constant) \
448 macro(ConstantAggregateZero) \
449 macro(ConstantArray) \
450 macro(ConstantExpr) \
451 macro(ConstantFP) \
452 macro(ConstantInt) \
453 macro(ConstantPointerNull) \
454 macro(ConstantStruct) \
455 macro(ConstantVector) \
456 macro(GlobalValue) \
457 macro(Function) \
458 macro(GlobalAlias) \
459 macro(GlobalVariable) \
460 macro(UndefValue) \
461 macro(Instruction) \
462 macro(BinaryOperator) \
463 macro(CallInst) \
464 macro(IntrinsicInst) \
465 macro(DbgInfoIntrinsic) \
466 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000467 macro(EHSelectorInst) \
468 macro(MemIntrinsic) \
469 macro(MemCpyInst) \
470 macro(MemMoveInst) \
471 macro(MemSetInst) \
472 macro(CmpInst) \
473 macro(FCmpInst) \
474 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000475 macro(ExtractElementInst) \
476 macro(GetElementPtrInst) \
477 macro(InsertElementInst) \
478 macro(InsertValueInst) \
Bill Wendlingfae14752011-08-12 20:24:12 +0000479 macro(LandingPadInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000480 macro(PHINode) \
481 macro(SelectInst) \
482 macro(ShuffleVectorInst) \
483 macro(StoreInst) \
484 macro(TerminatorInst) \
485 macro(BranchInst) \
486 macro(InvokeInst) \
487 macro(ReturnInst) \
488 macro(SwitchInst) \
489 macro(UnreachableInst) \
Bill Wendlingf891bf82011-07-31 06:30:59 +0000490 macro(ResumeInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000491 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000492 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000493 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000494 macro(BitCastInst) \
495 macro(FPExtInst) \
496 macro(FPToSIInst) \
497 macro(FPToUIInst) \
498 macro(FPTruncInst) \
499 macro(IntToPtrInst) \
500 macro(PtrToIntInst) \
501 macro(SExtInst) \
502 macro(SIToFPInst) \
503 macro(TruncInst) \
504 macro(UIToFPInst) \
505 macro(ZExtInst) \
506 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000507 macro(LoadInst) \
508 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000509
Gordon Henriksen76a03742007-09-18 03:18:57 +0000510/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000511LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000512const char *LLVMGetValueName(LLVMValueRef Val);
513void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000514void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000515void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000516int LLVMHasMetadata(LLVMValueRef Val);
517LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
518void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000519
Gordon Henriksen29e38942008-12-19 18:39:45 +0000520/* Conversion functions. Return the input value if it is an instance of the
521 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
522#define LLVM_DECLARE_VALUE_CAST(name) \
523 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
524LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
525
Chris Lattner40cf28d2009-10-12 04:01:02 +0000526/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000527LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
528LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
529LLVMValueRef LLVMGetUser(LLVMUseRef U);
530LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000531
532/* Operations on Users */
533LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Erick Tryzelaarb4d48702010-08-20 14:51:22 +0000534void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
535int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000536
Gordon Henriksen76a03742007-09-18 03:18:57 +0000537/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000538LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
539LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000540LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000541LLVMBool LLVMIsConstant(LLVMValueRef Val);
542LLVMBool LLVMIsNull(LLVMValueRef Val);
543LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000544LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000545
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000546/* Operations on metadata */
547LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
548 unsigned SLen);
549LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
550LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
551 unsigned Count);
552LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
Torok Edwinfec812e2011-10-06 12:13:11 +0000553const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
554int LLVMGetMDNodeNumOperands(LLVMValueRef V);
555LLVMValueRef *LLVMGetMDNodeOperand(LLVMValueRef V, unsigned i);
556unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
557void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000558
Gordon Henriksen76a03742007-09-18 03:18:57 +0000559/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000560LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000561 LLVMBool SignExtend);
Chris Lattner4329e072010-11-23 02:47:22 +0000562LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
563 unsigned NumWords,
564 const uint64_t Words[]);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000565LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
566 uint8_t Radix);
567LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
568 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000569LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000570LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000571LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
572 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000573unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
574long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000575
Gordon Henriksen76a03742007-09-18 03:18:57 +0000576
577/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000578LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000579 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000580LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
581 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000582 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000583
Gordon Henriksen1046c732007-10-06 15:11:06 +0000584LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000585 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000586LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000587 LLVMValueRef *ConstantVals, unsigned Length);
588LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000589 LLVMBool Packed);
Rafael Espindola784ad242011-07-14 19:09:08 +0000590LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
591 LLVMValueRef *ConstantVals,
592 unsigned Count);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000593LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000594
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000595/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000596LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000597LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000598LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
599LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000600LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
601LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000602LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000603LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
604LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000605LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000606LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000607LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000608LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000609LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000611LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000612LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000613LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
614LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000615LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000616LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
617LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000618LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000619LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
620LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
621LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
622LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
623LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
624LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
625LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
626LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
627 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
628LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
629 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
630LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
631LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
632LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
633LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
634 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000635LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
636 LLVMValueRef *ConstantIndices,
637 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000638LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
639LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
640LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
641LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
642LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
643LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
644LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
645LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
646LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
647LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
648LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
649LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000650LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
651 LLVMTypeRef ToType);
652LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
653 LLVMTypeRef ToType);
654LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
655 LLVMTypeRef ToType);
656LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
657 LLVMTypeRef ToType);
658LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000659 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000660LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000661LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
662 LLVMValueRef ConstantIfTrue,
663 LLVMValueRef ConstantIfFalse);
664LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
665 LLVMValueRef IndexConstant);
666LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
667 LLVMValueRef ElementValueConstant,
668 LLVMValueRef IndexConstant);
669LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
670 LLVMValueRef VectorBConstant,
671 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000672LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
673 unsigned NumIdx);
674LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
675 LLVMValueRef ElementValueConstant,
676 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000677LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000678 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000679 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000680LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000681
Gordon Henriksen76a03742007-09-18 03:18:57 +0000682/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000683LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000684LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000685LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
686void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
687const char *LLVMGetSection(LLVMValueRef Global);
688void LLVMSetSection(LLVMValueRef Global, const char *Section);
689LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
690void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
691unsigned LLVMGetAlignment(LLVMValueRef Global);
692void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
693
694/* Operations on global variables */
695LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000696LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
697 const char *Name,
698 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000699LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000700LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
701LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
702LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
703LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000704void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000705LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
706void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000707LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
708void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
709LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
710void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000711
Chris Lattner3d1f5522008-12-17 21:39:50 +0000712/* Operations on aliases */
713LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
714 const char *Name);
715
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000716/* Operations on functions */
717LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
718 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000719LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000720LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
721LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
722LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
723LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000724void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000725unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
726unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
727void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000728const char *LLVMGetGC(LLVMValueRef Fn);
729void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000730void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000731LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000732void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000733
Gordon Henriksen265f7802008-03-19 01:11:35 +0000734/* Operations on parameters */
735unsigned LLVMCountParams(LLVMValueRef Fn);
736void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
737LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
738LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000739LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
740LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
741LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
742LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000743void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
744void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000745LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000746void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000747
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000748/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000749LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000750LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000751LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000752LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Nate Begeman43c322b2011-08-23 20:27:46 +0000753LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000754unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
755void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000756LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
757LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
758LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
759LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000760LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000761
762LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
763 LLVMValueRef Fn,
764 const char *Name);
765LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
766 LLVMBasicBlockRef BB,
767 const char *Name);
768
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000769LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
770LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
771 const char *Name);
772void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
Nate Begeman43c322b2011-08-23 20:27:46 +0000773void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000774
Duncan Sandsb1d61aa2010-07-19 15:31:07 +0000775void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
776void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
777
Gordon Henriksen054817c2008-03-19 03:47:18 +0000778LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
779LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
Nate Begeman43c322b2011-08-23 20:27:46 +0000780
781/* Operations on instructions */
782LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000783LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
784LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Devang Pateldbebc6f2011-10-03 20:59:18 +0000785void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000786
Gordon Henriksen1158c532007-12-29 20:45:00 +0000787/* Operations on call sites */
788void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
789unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000790void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
791void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
792 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000793void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
794 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000795
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000796/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000797LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
798void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000799
Nate Begeman43c322b2011-08-23 20:27:46 +0000800/* Operations on switch instructions (only) */
801LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
802
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000803/* Operations on phi nodes */
804void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
805 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
806unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
807LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
808LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000809
810/*===-- Instruction builders ----------------------------------------------===*/
811
812/* An instruction builder represents a point within a basic block, and is the
813 * exclusive means of building instructions using the C interface.
814 */
815
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000816LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000817LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000818void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
819 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000820void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
821void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000822LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000823void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
824void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000825void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
826 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000827void LLVMDisposeBuilder(LLVMBuilderRef Builder);
828
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000829/* Metadata */
830void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
831LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
832void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
833
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000834/* Terminators */
835LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
836LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000837LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000838 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000839LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
840LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
841 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
842LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
843 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000844LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
845 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000846LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
847 LLVMValueRef *Args, unsigned NumArgs,
848 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
849 const char *Name);
Benjamin Kramer5a6568832011-08-19 01:36:54 +0000850LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
851 LLVMValueRef PersFn, unsigned NumClauses,
852 const char *Name);
Bill Wendlingf891bf82011-07-31 06:30:59 +0000853LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000854LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
855
Gordon Henriksen097102c2008-01-01 05:50:53 +0000856/* Add a case to the switch instruction */
857void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
858 LLVMBasicBlockRef Dest);
859
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000860/* Add a destination to the indirectbr instruction */
861void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
862
Bill Wendlingfae14752011-08-12 20:24:12 +0000863/* Add a catch or filter clause to the landingpad instruction */
864void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
865
866/* Set the 'cleanup' flag in the landingpad instruction */
867void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
868
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000869/* Arithmetic */
870LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
871 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000872LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
873 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000874LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
875 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000876LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
877 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000878LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
879 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000880LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
881 const char *Name);
882LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
883 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000884LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
885 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000886LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
887 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000888LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
889 const char *Name);
890LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
891 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000892LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
893 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000894LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
895 const char *Name);
896LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
897 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000898LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
899 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000900LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
901 const char *Name);
902LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
903 const char *Name);
904LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
905 const char *Name);
906LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
907 const char *Name);
908LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
909 const char *Name);
910LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
911 const char *Name);
912LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
913 const char *Name);
914LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
915 const char *Name);
916LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
917 const char *Name);
918LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
919 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000920LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
921 LLVMValueRef LHS, LLVMValueRef RHS,
922 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000923LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000924LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
925 const char *Name);
926LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
927 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000928LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000929LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
930
931/* Memory */
932LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
933LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
934 LLVMValueRef Val, const char *Name);
935LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
936LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
937 LLVMValueRef Val, const char *Name);
938LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
939LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
940 const char *Name);
941LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
942LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
943 LLVMValueRef *Indices, unsigned NumIndices,
944 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000945LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
946 LLVMValueRef *Indices, unsigned NumIndices,
947 const char *Name);
948LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
949 unsigned Idx, const char *Name);
950LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
951 const char *Name);
952LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
953 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000954
955/* Casts */
956LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
957 LLVMTypeRef DestTy, const char *Name);
958LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
959 LLVMTypeRef DestTy, const char *Name);
960LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
961 LLVMTypeRef DestTy, const char *Name);
962LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
963 LLVMTypeRef DestTy, const char *Name);
964LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
965 LLVMTypeRef DestTy, const char *Name);
966LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
967 LLVMTypeRef DestTy, const char *Name);
968LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
969 LLVMTypeRef DestTy, const char *Name);
970LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
971 LLVMTypeRef DestTy, const char *Name);
972LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
973 LLVMTypeRef DestTy, const char *Name);
974LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
975 LLVMTypeRef DestTy, const char *Name);
976LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
977 LLVMTypeRef DestTy, const char *Name);
978LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
979 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000980LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
981 LLVMTypeRef DestTy, const char *Name);
982LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
983 LLVMTypeRef DestTy, const char *Name);
984LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
985 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000986LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
987 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000988LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
989 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000990LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000991 LLVMTypeRef DestTy, const char *Name);
992LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
993 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000994
995/* Comparisons */
996LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
997 LLVMValueRef LHS, LLVMValueRef RHS,
998 const char *Name);
999LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
1000 LLVMValueRef LHS, LLVMValueRef RHS,
1001 const char *Name);
1002
1003/* Miscellaneous instructions */
1004LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
1005LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
1006 LLVMValueRef *Args, unsigned NumArgs,
1007 const char *Name);
1008LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
1009 LLVMValueRef Then, LLVMValueRef Else,
1010 const char *Name);
1011LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
1012 const char *Name);
1013LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
1014 LLVMValueRef Index, const char *Name);
1015LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
1016 LLVMValueRef EltVal, LLVMValueRef Index,
1017 const char *Name);
1018LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
1019 LLVMValueRef V2, LLVMValueRef Mask,
1020 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +00001021LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
1022 unsigned Index, const char *Name);
1023LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
1024 LLVMValueRef EltVal, unsigned Index,
1025 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001026
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00001027LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
1028 const char *Name);
1029LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
1030 const char *Name);
1031LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
1032 LLVMValueRef RHS, const char *Name);
1033
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001034
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001035/*===-- Module providers --------------------------------------------------===*/
1036
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001037/* Changes the type of M so it can be passed to FunctionPassManagers and the
1038 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001039 */
1040LLVMModuleProviderRef
1041LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1042
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001043/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001044 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001045void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001046
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001047
1048/*===-- Memory buffers ----------------------------------------------------===*/
1049
Chris Lattner25963c62010-01-09 22:27:07 +00001050LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1051 LLVMMemoryBufferRef *OutMemBuf,
1052 char **OutMessage);
1053LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1054 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001055void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1056
Owen Anderson4698c5d2010-10-07 17:55:47 +00001057/*===-- Pass Registry -----------------------------------------------------===*/
1058
1059/** Return the global pass registry, for use with initialization functions.
1060 See llvm::PassRegistry::getPassRegistry. */
1061LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001062
1063/*===-- Pass Managers -----------------------------------------------------===*/
1064
1065/** Constructs a new whole-module pass pipeline. This type of pipeline is
1066 suitable for link-time optimization and whole-module transformations.
1067 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001068LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001069
1070/** Constructs a new function-by-function pass pipeline over the module
1071 provider. It does not take ownership of the module provider. This type of
1072 pipeline is suitable for code generation and JIT compilation tasks.
1073 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001074LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1075
1076/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001077LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1078
1079/** Initializes, executes on the provided module, and finalizes all of the
1080 passes scheduled in the pass manager. Returns 1 if any of the passes
1081 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001082LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001083
1084/** Initializes all of the function passes scheduled in the function pass
1085 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1086 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001087LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001088
1089/** Executes all of the function passes scheduled in the function pass manager
1090 on the provided function. Returns 1 if any of the passes modified the
1091 function, false otherwise.
1092 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001093LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001094
1095/** Finalizes all of the function passes scheduled in in the function pass
1096 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1097 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001098LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001099
1100/** Frees the memory of a pass pipeline. For function pipelines, does not free
1101 the module provider.
1102 See llvm::PassManagerBase::~PassManagerBase. */
1103void LLVMDisposePassManager(LLVMPassManagerRef PM);
1104
1105
Gordon Henriksen76a03742007-09-18 03:18:57 +00001106#ifdef __cplusplus
1107}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001108
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001109namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001110 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001111 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001112
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001113 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1114 inline ty *unwrap(ref P) { \
1115 return reinterpret_cast<ty*>(P); \
1116 } \
1117 \
1118 inline ref wrap(const ty *P) { \
1119 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1120 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001121
Gordon Henriksen878114b2008-03-16 04:20:44 +00001122 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1123 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1124 \
1125 template<typename T> \
1126 inline T *unwrap(ref P) { \
1127 return cast<T>(unwrap(P)); \
1128 }
1129
1130 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1131 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1132 \
1133 template<typename T> \
1134 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001135 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001136 assert(Q && "Invalid cast!"); \
1137 return Q; \
1138 }
1139
1140 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1141 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001142 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1143 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001144 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001145 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001146 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001147 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001148 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Owen Anderson4698c5d2010-10-07 17:55:47 +00001149 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001150 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1151 * Module.
1152 */
1153 inline Module *unwrap(LLVMModuleProviderRef MP) {
1154 return reinterpret_cast<Module*>(MP);
1155 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001156
Gordon Henriksen878114b2008-03-16 04:20:44 +00001157 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1158 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001159 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001160
1161 /* Specialized opaque context conversions.
1162 */
1163 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1164 return reinterpret_cast<LLVMContext**>(Tys);
1165 }
1166
1167 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1168 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1169 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001170
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001171 /* Specialized opaque type conversions.
1172 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001173 inline Type **unwrap(LLVMTypeRef* Tys) {
1174 return reinterpret_cast<Type**>(Tys);
1175 }
1176
Chris Lattner229907c2011-07-18 04:54:35 +00001177 inline LLVMTypeRef *wrap(Type **Tys) {
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001178 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1179 }
1180
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001181 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001182 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001183 inline Value **unwrap(LLVMValueRef *Vals) {
1184 return reinterpret_cast<Value**>(Vals);
1185 }
1186
1187 template<typename T>
1188 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1189 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001190 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001191 cast<T>(*I);
1192 #endif
Hans Wennborg8f7edbf2011-06-04 16:00:19 +00001193 (void)Length;
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001194 return reinterpret_cast<T**>(Vals);
1195 }
1196
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001197 inline LLVMValueRef *wrap(const Value **Vals) {
1198 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1199 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001200}
1201
1202#endif /* !defined(__cplusplus) */
1203
1204#endif /* !defined(LLVM_C_CORE_H) */