blob: 782b7eae9a26117c3fe4d345e1b547e345441f26 [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,
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 */
194 LLVMResume = 58
Bill Wendling2641d132011-07-27 21:00:28 +0000195
Chris Lattner40cf28d2009-10-12 04:01:02 +0000196} LLVMOpcode;
197
198typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000199 LLVMVoidTypeKind, /**< type with no size */
200 LLVMFloatTypeKind, /**< 32 bit floating point type */
201 LLVMDoubleTypeKind, /**< 64 bit floating point type */
202 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
203 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
204 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
205 LLVMLabelTypeKind, /**< Labels */
206 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
207 LLVMFunctionTypeKind, /**< Functions */
208 LLVMStructTypeKind, /**< Structures */
209 LLVMArrayTypeKind, /**< Arrays */
210 LLVMPointerTypeKind, /**< Pointers */
Chris Lattnerdac44ec2009-07-15 22:00:31 +0000211 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
Dale Johannesenbaa5d042010-09-10 20:55:01 +0000212 LLVMMetadataTypeKind, /**< Metadata */
213 LLVMX86_MMXTypeKind /**< X86 MMX */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000214} LLVMTypeKind;
215
216typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000217 LLVMExternalLinkage, /**< Externally visible function */
Chris Lattner2dba0f02009-04-13 06:25:37 +0000218 LLVMAvailableExternallyLinkage,
Duncan Sands12da8ce2009-03-07 15:45:40 +0000219 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
220 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
221 equivalent. */
222 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
223 LLVMWeakODRLinkage, /**< Same, but only replaced by something
224 equivalent. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000225 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
226 LLVMInternalLinkage, /**< Rename collisions when linking (static
227 functions) */
Duncan Sands12da8ce2009-03-07 15:45:40 +0000228 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000229 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
230 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
Duncan Sandse2881052009-03-11 08:08:06 +0000231 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000232 LLVMGhostLinkage, /**< Obsolete */
Bill Wendling002b1672009-07-20 18:22:52 +0000233 LLVMCommonLinkage, /**< Tentative definitions */
Bill Wendling03bcd6e2010-07-01 21:55:59 +0000234 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
Bill Wendling578ee402010-08-20 22:05:50 +0000235 LLVMLinkerPrivateWeakLinkage, /**< Like LinkerPrivate, but is weak. */
236 LLVMLinkerPrivateWeakDefAutoLinkage /**< Like LinkerPrivateWeak, but possibly
237 hidden. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000238} LLVMLinkage;
239
240typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000241 LLVMDefaultVisibility, /**< The GV is visible */
242 LLVMHiddenVisibility, /**< The GV is hidden */
243 LLVMProtectedVisibility /**< The GV is protected */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000244} LLVMVisibility;
245
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000246typedef enum {
247 LLVMCCallConv = 0,
248 LLVMFastCallConv = 8,
249 LLVMColdCallConv = 9,
250 LLVMX86StdcallCallConv = 64,
251 LLVMX86FastcallCallConv = 65
252} LLVMCallConv;
253
254typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000255 LLVMIntEQ = 32, /**< equal */
256 LLVMIntNE, /**< not equal */
257 LLVMIntUGT, /**< unsigned greater than */
258 LLVMIntUGE, /**< unsigned greater or equal */
259 LLVMIntULT, /**< unsigned less than */
260 LLVMIntULE, /**< unsigned less or equal */
261 LLVMIntSGT, /**< signed greater than */
262 LLVMIntSGE, /**< signed greater or equal */
263 LLVMIntSLT, /**< signed less than */
264 LLVMIntSLE /**< signed less or equal */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000265} LLVMIntPredicate;
266
267typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000268 LLVMRealPredicateFalse, /**< Always false (always folded) */
269 LLVMRealOEQ, /**< True if ordered and equal */
270 LLVMRealOGT, /**< True if ordered and greater than */
271 LLVMRealOGE, /**< True if ordered and greater than or equal */
272 LLVMRealOLT, /**< True if ordered and less than */
273 LLVMRealOLE, /**< True if ordered and less than or equal */
274 LLVMRealONE, /**< True if ordered and operands are unequal */
275 LLVMRealORD, /**< True if ordered (no nans) */
276 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
277 LLVMRealUEQ, /**< True if unordered or equal */
278 LLVMRealUGT, /**< True if unordered or greater than */
279 LLVMRealUGE, /**< True if unordered, greater than, or equal */
280 LLVMRealULT, /**< True if unordered or less than */
281 LLVMRealULE, /**< True if unordered, less than, or equal */
282 LLVMRealUNE, /**< True if unordered or not equal */
283 LLVMRealPredicateTrue /**< Always true (always folded) */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000284} LLVMRealPredicate;
285
Nick Lewycky0db26542011-05-15 07:20:34 +0000286void LLVMInitializeCore(LLVMPassRegistryRef R);
287
Gordon Henriksen76a03742007-09-18 03:18:57 +0000288
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000289/*===-- Error handling ----------------------------------------------------===*/
290
291void LLVMDisposeMessage(char *Message);
292
293
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000294/*===-- Contexts ----------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000295
Owen Anderson6773d382009-07-01 16:58:40 +0000296/* Create and destroy contexts. */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000297LLVMContextRef LLVMContextCreate(void);
298LLVMContextRef LLVMGetGlobalContext(void);
Owen Anderson6773d382009-07-01 16:58:40 +0000299void LLVMContextDispose(LLVMContextRef C);
300
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000301unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
302 unsigned SLen);
303unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
304
305/*===-- Modules -----------------------------------------------------------===*/
306
Gordon Henriksen76a03742007-09-18 03:18:57 +0000307/* Create and destroy modules. */
Gordon Henriksena49d4352008-03-07 19:13:06 +0000308/** See llvm::Module::Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000309LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Owen Anderson31d44e42009-07-02 07:17:57 +0000310LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
311 LLVMContextRef C);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000312
313/** See llvm::Module::~Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000314void LLVMDisposeModule(LLVMModuleRef M);
315
Gordon Henriksena49d4352008-03-07 19:13:06 +0000316/** Data layout. See Module::getDataLayout. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000317const char *LLVMGetDataLayout(LLVMModuleRef M);
318void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
319
Gordon Henriksena49d4352008-03-07 19:13:06 +0000320/** Target triple. See Module::getTargetTriple. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000321const char *LLVMGetTarget(LLVMModuleRef M);
322void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
323
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000324/** See Module::dump. */
325void LLVMDumpModule(LLVMModuleRef M);
326
Chris Lattner26941452010-04-10 17:52:58 +0000327/** See Module::setModuleInlineAsm. */
328void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000329
Chris Lattnera7e04b02010-11-28 20:03:44 +0000330/** See Module::getContext. */
331LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
332
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000333/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000334
335/* LLVM types conform to the following hierarchy:
336 *
337 * types:
338 * integer type
339 * real type
340 * function type
341 * sequence types:
342 * array type
343 * pointer type
344 * vector type
345 * void type
346 * label type
347 * opaque type
348 */
349
Gordon Henriksena49d4352008-03-07 19:13:06 +0000350/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000351LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000352
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000353/** See llvm::LLVMType::getContext. */
354LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
355
Gordon Henriksen76a03742007-09-18 03:18:57 +0000356/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000357LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
358LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
359LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
360LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
361LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
362LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
363
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000364LLVMTypeRef LLVMInt1Type(void);
365LLVMTypeRef LLVMInt8Type(void);
366LLVMTypeRef LLVMInt16Type(void);
367LLVMTypeRef LLVMInt32Type(void);
368LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000369LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000370unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000371
372/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000373LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
374LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
375LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
376LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
377LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
378
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000379LLVMTypeRef LLVMFloatType(void);
380LLVMTypeRef LLVMDoubleType(void);
381LLVMTypeRef LLVMX86FP80Type(void);
382LLVMTypeRef LLVMFP128Type(void);
383LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000384
385/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000386LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
387 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000388 LLVMBool IsVarArg);
389LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000390LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
391unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
392void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000393
394/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000395LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000396 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000397LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000398 LLVMBool Packed);
Chris Lattnere71ccde2011-07-14 05:53:17 +0000399LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
400void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
401 unsigned ElementCount, LLVMBool Packed);
402
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000403unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000404void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000405LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Chris Lattner17cf05b2011-07-14 16:20:28 +0000406LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
407
408LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000409
410/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000411LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000412LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000413LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000414
415LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
416unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000417unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000418unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
419
420/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000421LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
422LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000423LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000424
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000425LLVMTypeRef LLVMVoidType(void);
426LLVMTypeRef LLVMLabelType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000427LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000428
Gordon Henriksen76a03742007-09-18 03:18:57 +0000429/*===-- Values ------------------------------------------------------------===*/
430
431/* The bulk of LLVM's object model consists of values, which comprise a very
432 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000433 */
434
Gordon Henriksen29e38942008-12-19 18:39:45 +0000435#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
436 macro(Argument) \
437 macro(BasicBlock) \
438 macro(InlineAsm) \
439 macro(User) \
440 macro(Constant) \
441 macro(ConstantAggregateZero) \
442 macro(ConstantArray) \
443 macro(ConstantExpr) \
444 macro(ConstantFP) \
445 macro(ConstantInt) \
446 macro(ConstantPointerNull) \
447 macro(ConstantStruct) \
448 macro(ConstantVector) \
449 macro(GlobalValue) \
450 macro(Function) \
451 macro(GlobalAlias) \
452 macro(GlobalVariable) \
453 macro(UndefValue) \
454 macro(Instruction) \
455 macro(BinaryOperator) \
456 macro(CallInst) \
457 macro(IntrinsicInst) \
458 macro(DbgInfoIntrinsic) \
459 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000460 macro(EHSelectorInst) \
461 macro(MemIntrinsic) \
462 macro(MemCpyInst) \
463 macro(MemMoveInst) \
464 macro(MemSetInst) \
465 macro(CmpInst) \
466 macro(FCmpInst) \
467 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000468 macro(ExtractElementInst) \
469 macro(GetElementPtrInst) \
470 macro(InsertElementInst) \
471 macro(InsertValueInst) \
472 macro(PHINode) \
473 macro(SelectInst) \
474 macro(ShuffleVectorInst) \
475 macro(StoreInst) \
476 macro(TerminatorInst) \
477 macro(BranchInst) \
478 macro(InvokeInst) \
479 macro(ReturnInst) \
480 macro(SwitchInst) \
481 macro(UnreachableInst) \
482 macro(UnwindInst) \
Bill Wendlingf891bf82011-07-31 06:30:59 +0000483 macro(ResumeInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000484 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000485 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000486 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000487 macro(BitCastInst) \
488 macro(FPExtInst) \
489 macro(FPToSIInst) \
490 macro(FPToUIInst) \
491 macro(FPTruncInst) \
492 macro(IntToPtrInst) \
493 macro(PtrToIntInst) \
494 macro(SExtInst) \
495 macro(SIToFPInst) \
496 macro(TruncInst) \
497 macro(UIToFPInst) \
498 macro(ZExtInst) \
499 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000500 macro(LoadInst) \
501 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000502
Gordon Henriksen76a03742007-09-18 03:18:57 +0000503/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000504LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000505const char *LLVMGetValueName(LLVMValueRef Val);
506void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000507void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000508void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000509int LLVMHasMetadata(LLVMValueRef Val);
510LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
511void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000512
Gordon Henriksen29e38942008-12-19 18:39:45 +0000513/* Conversion functions. Return the input value if it is an instance of the
514 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
515#define LLVM_DECLARE_VALUE_CAST(name) \
516 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
517LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
518
Chris Lattner40cf28d2009-10-12 04:01:02 +0000519/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000520LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
521LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
522LLVMValueRef LLVMGetUser(LLVMUseRef U);
523LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000524
525/* Operations on Users */
526LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Erick Tryzelaarb4d48702010-08-20 14:51:22 +0000527void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
528int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000529
Gordon Henriksen76a03742007-09-18 03:18:57 +0000530/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000531LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
532LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000533LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000534LLVMBool LLVMIsConstant(LLVMValueRef Val);
535LLVMBool LLVMIsNull(LLVMValueRef Val);
536LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000537LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000538
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000539/* Operations on metadata */
540LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
541 unsigned SLen);
542LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
543LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
544 unsigned Count);
545LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
546
Gordon Henriksen76a03742007-09-18 03:18:57 +0000547/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000548LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000549 LLVMBool SignExtend);
Chris Lattner4329e072010-11-23 02:47:22 +0000550LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
551 unsigned NumWords,
552 const uint64_t Words[]);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000553LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
554 uint8_t Radix);
555LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
556 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000557LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000558LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000559LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
560 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000561unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
562long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000563
Gordon Henriksen76a03742007-09-18 03:18:57 +0000564
565/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000566LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000567 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000568LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
569 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000570 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000571
Gordon Henriksen1046c732007-10-06 15:11:06 +0000572LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000573 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000574LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000575 LLVMValueRef *ConstantVals, unsigned Length);
576LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000577 LLVMBool Packed);
Rafael Espindola784ad242011-07-14 19:09:08 +0000578LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
579 LLVMValueRef *ConstantVals,
580 unsigned Count);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000581LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000582
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000583/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000584LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000585LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000586LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
587LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000588LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
589LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000590LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000591LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
592LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000593LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000594LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000595LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000596LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000597LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
598LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000599LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000600LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000601LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
602LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000603LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000604LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
605LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000606LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000607LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
609LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
611LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
612LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
613LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
614LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
615 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
616LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
617 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
618LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
619LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
620LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
621LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
622 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000623LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
624 LLVMValueRef *ConstantIndices,
625 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000626LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
627LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
628LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
629LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
630LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
631LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
632LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
633LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
634LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
635LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
636LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
637LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000638LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
639 LLVMTypeRef ToType);
640LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
641 LLVMTypeRef ToType);
642LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
643 LLVMTypeRef ToType);
644LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
645 LLVMTypeRef ToType);
646LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000647 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000648LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000649LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
650 LLVMValueRef ConstantIfTrue,
651 LLVMValueRef ConstantIfFalse);
652LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
653 LLVMValueRef IndexConstant);
654LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
655 LLVMValueRef ElementValueConstant,
656 LLVMValueRef IndexConstant);
657LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
658 LLVMValueRef VectorBConstant,
659 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000660LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
661 unsigned NumIdx);
662LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
663 LLVMValueRef ElementValueConstant,
664 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000665LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000666 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000667 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000668LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000669
Gordon Henriksen76a03742007-09-18 03:18:57 +0000670/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000671LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000672LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000673LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
674void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
675const char *LLVMGetSection(LLVMValueRef Global);
676void LLVMSetSection(LLVMValueRef Global, const char *Section);
677LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
678void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
679unsigned LLVMGetAlignment(LLVMValueRef Global);
680void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
681
682/* Operations on global variables */
683LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000684LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
685 const char *Name,
686 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000687LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000688LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
689LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
690LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
691LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000692void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000693LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
694void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000695LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
696void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
697LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
698void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000699
Chris Lattner3d1f5522008-12-17 21:39:50 +0000700/* Operations on aliases */
701LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
702 const char *Name);
703
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000704/* Operations on functions */
705LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
706 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000707LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000708LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
709LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
710LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
711LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000712void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000713unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
714unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
715void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000716const char *LLVMGetGC(LLVMValueRef Fn);
717void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000718void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000719LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000720void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000721
Gordon Henriksen265f7802008-03-19 01:11:35 +0000722/* Operations on parameters */
723unsigned LLVMCountParams(LLVMValueRef Fn);
724void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
725LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
726LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000727LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
728LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
729LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
730LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000731void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
732void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000733LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000734void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000735
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000736/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000737LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000738LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000739LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000740LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000741unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
742void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000743LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
744LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
745LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
746LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000747LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000748
749LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
750 LLVMValueRef Fn,
751 const char *Name);
752LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
753 LLVMBasicBlockRef BB,
754 const char *Name);
755
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000756LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
757LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
758 const char *Name);
759void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
760
Duncan Sandsb1d61aa2010-07-19 15:31:07 +0000761void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
762void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
763
Gordon Henriksen265f7802008-03-19 01:11:35 +0000764/* Operations on instructions */
765LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000766LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
767LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
768LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
769LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000770
Gordon Henriksen1158c532007-12-29 20:45:00 +0000771/* Operations on call sites */
772void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
773unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000774void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
775void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
776 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000777void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
778 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000779
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000780/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000781LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
782void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000783
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000784/* Operations on phi nodes */
785void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
786 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
787unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
788LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
789LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000790
791/*===-- Instruction builders ----------------------------------------------===*/
792
793/* An instruction builder represents a point within a basic block, and is the
794 * exclusive means of building instructions using the C interface.
795 */
796
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000797LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000798LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000799void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
800 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000801void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
802void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000803LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000804void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
805void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000806void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
807 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000808void LLVMDisposeBuilder(LLVMBuilderRef Builder);
809
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000810/* Metadata */
811void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
812LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
813void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
814
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000815/* Terminators */
816LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
817LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000818LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000819 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000820LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
821LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
822 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
823LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
824 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000825LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
826 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000827LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
828 LLVMValueRef *Args, unsigned NumArgs,
829 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
830 const char *Name);
831LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
Bill Wendlingf891bf82011-07-31 06:30:59 +0000832LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000833LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
834
Gordon Henriksen097102c2008-01-01 05:50:53 +0000835/* Add a case to the switch instruction */
836void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
837 LLVMBasicBlockRef Dest);
838
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000839/* Add a destination to the indirectbr instruction */
840void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
841
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000842/* Arithmetic */
843LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
844 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000845LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
846 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000847LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
848 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000849LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
850 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000851LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
852 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000853LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
854 const char *Name);
855LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
856 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000857LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
858 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000859LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
860 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000861LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
862 const char *Name);
863LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
864 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000865LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
866 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000867LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
868 const char *Name);
869LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
870 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000871LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
872 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000873LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
874 const char *Name);
875LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
876 const char *Name);
877LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
878 const char *Name);
879LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
880 const char *Name);
881LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
882 const char *Name);
883LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
884 const char *Name);
885LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
886 const char *Name);
887LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
888 const char *Name);
889LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
890 const char *Name);
891LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
892 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000893LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
894 LLVMValueRef LHS, LLVMValueRef RHS,
895 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000896LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000897LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
898 const char *Name);
899LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
900 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000901LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000902LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
903
904/* Memory */
905LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
906LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
907 LLVMValueRef Val, const char *Name);
908LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
909LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
910 LLVMValueRef Val, const char *Name);
911LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
912LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
913 const char *Name);
914LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
915LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
916 LLVMValueRef *Indices, unsigned NumIndices,
917 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000918LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
919 LLVMValueRef *Indices, unsigned NumIndices,
920 const char *Name);
921LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
922 unsigned Idx, const char *Name);
923LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
924 const char *Name);
925LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
926 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000927
928/* Casts */
929LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
930 LLVMTypeRef DestTy, const char *Name);
931LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
932 LLVMTypeRef DestTy, const char *Name);
933LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
934 LLVMTypeRef DestTy, const char *Name);
935LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
936 LLVMTypeRef DestTy, const char *Name);
937LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
938 LLVMTypeRef DestTy, const char *Name);
939LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
940 LLVMTypeRef DestTy, const char *Name);
941LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
942 LLVMTypeRef DestTy, const char *Name);
943LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
944 LLVMTypeRef DestTy, const char *Name);
945LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
946 LLVMTypeRef DestTy, const char *Name);
947LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
948 LLVMTypeRef DestTy, const char *Name);
949LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
950 LLVMTypeRef DestTy, const char *Name);
951LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
952 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000953LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
954 LLVMTypeRef DestTy, const char *Name);
955LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
956 LLVMTypeRef DestTy, const char *Name);
957LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
958 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000959LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
960 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000961LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
962 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000963LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000964 LLVMTypeRef DestTy, const char *Name);
965LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
966 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000967
968/* Comparisons */
969LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
970 LLVMValueRef LHS, LLVMValueRef RHS,
971 const char *Name);
972LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
973 LLVMValueRef LHS, LLVMValueRef RHS,
974 const char *Name);
975
976/* Miscellaneous instructions */
977LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
978LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
979 LLVMValueRef *Args, unsigned NumArgs,
980 const char *Name);
981LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
982 LLVMValueRef Then, LLVMValueRef Else,
983 const char *Name);
984LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
985 const char *Name);
986LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
987 LLVMValueRef Index, const char *Name);
988LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
989 LLVMValueRef EltVal, LLVMValueRef Index,
990 const char *Name);
991LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
992 LLVMValueRef V2, LLVMValueRef Mask,
993 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000994LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
995 unsigned Index, const char *Name);
996LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
997 LLVMValueRef EltVal, unsigned Index,
998 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000999
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00001000LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
1001 const char *Name);
1002LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
1003 const char *Name);
1004LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
1005 LLVMValueRef RHS, const char *Name);
1006
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001007
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001008/*===-- Module providers --------------------------------------------------===*/
1009
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001010/* Changes the type of M so it can be passed to FunctionPassManagers and the
1011 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001012 */
1013LLVMModuleProviderRef
1014LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1015
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001016/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001017 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001018void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001019
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001020
1021/*===-- Memory buffers ----------------------------------------------------===*/
1022
Chris Lattner25963c62010-01-09 22:27:07 +00001023LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1024 LLVMMemoryBufferRef *OutMemBuf,
1025 char **OutMessage);
1026LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1027 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001028void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1029
Owen Anderson4698c5d2010-10-07 17:55:47 +00001030/*===-- Pass Registry -----------------------------------------------------===*/
1031
1032/** Return the global pass registry, for use with initialization functions.
1033 See llvm::PassRegistry::getPassRegistry. */
1034LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001035
1036/*===-- Pass Managers -----------------------------------------------------===*/
1037
1038/** Constructs a new whole-module pass pipeline. This type of pipeline is
1039 suitable for link-time optimization and whole-module transformations.
1040 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001041LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001042
1043/** Constructs a new function-by-function pass pipeline over the module
1044 provider. It does not take ownership of the module provider. This type of
1045 pipeline is suitable for code generation and JIT compilation tasks.
1046 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001047LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1048
1049/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001050LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1051
1052/** Initializes, executes on the provided module, and finalizes all of the
1053 passes scheduled in the pass manager. Returns 1 if any of the passes
1054 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001055LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001056
1057/** Initializes all of the function passes scheduled in the function pass
1058 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1059 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001060LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001061
1062/** Executes all of the function passes scheduled in the function pass manager
1063 on the provided function. Returns 1 if any of the passes modified the
1064 function, false otherwise.
1065 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001066LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001067
1068/** Finalizes all of the function passes scheduled in in the function pass
1069 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1070 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001071LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001072
1073/** Frees the memory of a pass pipeline. For function pipelines, does not free
1074 the module provider.
1075 See llvm::PassManagerBase::~PassManagerBase. */
1076void LLVMDisposePassManager(LLVMPassManagerRef PM);
1077
1078
Gordon Henriksen76a03742007-09-18 03:18:57 +00001079#ifdef __cplusplus
1080}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001081
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001082namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001083 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001084 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001085
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001086 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1087 inline ty *unwrap(ref P) { \
1088 return reinterpret_cast<ty*>(P); \
1089 } \
1090 \
1091 inline ref wrap(const ty *P) { \
1092 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1093 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001094
Gordon Henriksen878114b2008-03-16 04:20:44 +00001095 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1096 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1097 \
1098 template<typename T> \
1099 inline T *unwrap(ref P) { \
1100 return cast<T>(unwrap(P)); \
1101 }
1102
1103 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1104 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1105 \
1106 template<typename T> \
1107 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001108 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001109 assert(Q && "Invalid cast!"); \
1110 return Q; \
1111 }
1112
1113 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1114 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001115 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1116 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001117 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001118 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001119 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001120 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001121 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Owen Anderson4698c5d2010-10-07 17:55:47 +00001122 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001123 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1124 * Module.
1125 */
1126 inline Module *unwrap(LLVMModuleProviderRef MP) {
1127 return reinterpret_cast<Module*>(MP);
1128 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001129
Gordon Henriksen878114b2008-03-16 04:20:44 +00001130 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1131 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001132 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001133
1134 /* Specialized opaque context conversions.
1135 */
1136 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1137 return reinterpret_cast<LLVMContext**>(Tys);
1138 }
1139
1140 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1141 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1142 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001143
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001144 /* Specialized opaque type conversions.
1145 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001146 inline Type **unwrap(LLVMTypeRef* Tys) {
1147 return reinterpret_cast<Type**>(Tys);
1148 }
1149
Chris Lattner229907c2011-07-18 04:54:35 +00001150 inline LLVMTypeRef *wrap(Type **Tys) {
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001151 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1152 }
1153
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001154 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001155 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001156 inline Value **unwrap(LLVMValueRef *Vals) {
1157 return reinterpret_cast<Value**>(Vals);
1158 }
1159
1160 template<typename T>
1161 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1162 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001163 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001164 cast<T>(*I);
1165 #endif
Hans Wennborg8f7edbf2011-06-04 16:00:19 +00001166 (void)Length;
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001167 return reinterpret_cast<T**>(Vals);
1168 }
1169
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001170 inline LLVMValueRef *wrap(const Value **Vals) {
1171 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1172 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001173}
1174
1175#endif /* !defined(__cplusplus) */
1176
1177#endif /* !defined(LLVM_C_CORE_H) */