blob: 0acf5a23af264c6789fb70d0f9b10febb81db925 [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 */
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) \
Bill Wendlingf891bf82011-07-31 06:30:59 +0000482 macro(ResumeInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000483 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000484 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000485 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000486 macro(BitCastInst) \
487 macro(FPExtInst) \
488 macro(FPToSIInst) \
489 macro(FPToUIInst) \
490 macro(FPTruncInst) \
491 macro(IntToPtrInst) \
492 macro(PtrToIntInst) \
493 macro(SExtInst) \
494 macro(SIToFPInst) \
495 macro(TruncInst) \
496 macro(UIToFPInst) \
497 macro(ZExtInst) \
498 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000499 macro(LoadInst) \
500 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000501
Gordon Henriksen76a03742007-09-18 03:18:57 +0000502/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000503LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000504const char *LLVMGetValueName(LLVMValueRef Val);
505void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000506void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000507void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000508int LLVMHasMetadata(LLVMValueRef Val);
509LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
510void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000511
Gordon Henriksen29e38942008-12-19 18:39:45 +0000512/* Conversion functions. Return the input value if it is an instance of the
513 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
514#define LLVM_DECLARE_VALUE_CAST(name) \
515 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
516LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
517
Chris Lattner40cf28d2009-10-12 04:01:02 +0000518/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000519LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
520LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
521LLVMValueRef LLVMGetUser(LLVMUseRef U);
522LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000523
524/* Operations on Users */
525LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Erick Tryzelaarb4d48702010-08-20 14:51:22 +0000526void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
527int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000528
Gordon Henriksen76a03742007-09-18 03:18:57 +0000529/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000530LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
531LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000532LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000533LLVMBool LLVMIsConstant(LLVMValueRef Val);
534LLVMBool LLVMIsNull(LLVMValueRef Val);
535LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000536LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000537
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000538/* Operations on metadata */
539LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
540 unsigned SLen);
541LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
542LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
543 unsigned Count);
544LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
545
Gordon Henriksen76a03742007-09-18 03:18:57 +0000546/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000547LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000548 LLVMBool SignExtend);
Chris Lattner4329e072010-11-23 02:47:22 +0000549LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
550 unsigned NumWords,
551 const uint64_t Words[]);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000552LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
553 uint8_t Radix);
554LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
555 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000556LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000557LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000558LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
559 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000560unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
561long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000562
Gordon Henriksen76a03742007-09-18 03:18:57 +0000563
564/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000565LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000566 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000567LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
568 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000569 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000570
Gordon Henriksen1046c732007-10-06 15:11:06 +0000571LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000572 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000573LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000574 LLVMValueRef *ConstantVals, unsigned Length);
575LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000576 LLVMBool Packed);
Rafael Espindola784ad242011-07-14 19:09:08 +0000577LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
578 LLVMValueRef *ConstantVals,
579 unsigned Count);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000580LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000581
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000582/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000583LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000584LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000585LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
586LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000587LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
588LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000589LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000590LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
591LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000592LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000593LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000594LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000595LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000596LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
597LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000598LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000599LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000600LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
601LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000602LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000603LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
604LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000605LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000606LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
607LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
609LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
611LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
612LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
613LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
614 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
615LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
616 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
617LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
618LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
619LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
620LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
621 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000622LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
623 LLVMValueRef *ConstantIndices,
624 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000625LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
626LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
627LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
628LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
629LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
630LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
631LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
632LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
633LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
634LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
635LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
636LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000637LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
638 LLVMTypeRef ToType);
639LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
640 LLVMTypeRef ToType);
641LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
642 LLVMTypeRef ToType);
643LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
644 LLVMTypeRef ToType);
645LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000646 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000647LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000648LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
649 LLVMValueRef ConstantIfTrue,
650 LLVMValueRef ConstantIfFalse);
651LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
652 LLVMValueRef IndexConstant);
653LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
654 LLVMValueRef ElementValueConstant,
655 LLVMValueRef IndexConstant);
656LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
657 LLVMValueRef VectorBConstant,
658 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000659LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
660 unsigned NumIdx);
661LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
662 LLVMValueRef ElementValueConstant,
663 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000664LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000665 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000666 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000667LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000668
Gordon Henriksen76a03742007-09-18 03:18:57 +0000669/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000670LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000671LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000672LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
673void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
674const char *LLVMGetSection(LLVMValueRef Global);
675void LLVMSetSection(LLVMValueRef Global, const char *Section);
676LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
677void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
678unsigned LLVMGetAlignment(LLVMValueRef Global);
679void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
680
681/* Operations on global variables */
682LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000683LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
684 const char *Name,
685 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000686LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000687LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
688LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
689LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
690LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000691void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000692LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
693void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000694LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
695void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
696LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
697void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000698
Chris Lattner3d1f5522008-12-17 21:39:50 +0000699/* Operations on aliases */
700LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
701 const char *Name);
702
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000703/* Operations on functions */
704LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
705 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000706LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000707LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
708LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
709LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
710LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000711void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000712unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
713unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
714void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000715const char *LLVMGetGC(LLVMValueRef Fn);
716void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000717void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000718LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000719void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000720
Gordon Henriksen265f7802008-03-19 01:11:35 +0000721/* Operations on parameters */
722unsigned LLVMCountParams(LLVMValueRef Fn);
723void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
724LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
725LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000726LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
727LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
728LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
729LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000730void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
731void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000732LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000733void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000734
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000735/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000736LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000737LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000738LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000739LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000740unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
741void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000742LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
743LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
744LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
745LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000746LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000747
748LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
749 LLVMValueRef Fn,
750 const char *Name);
751LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
752 LLVMBasicBlockRef BB,
753 const char *Name);
754
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000755LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
756LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
757 const char *Name);
758void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
759
Duncan Sandsb1d61aa2010-07-19 15:31:07 +0000760void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
761void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
762
Gordon Henriksen265f7802008-03-19 01:11:35 +0000763/* Operations on instructions */
764LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000765LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
766LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
767LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
768LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000769
Gordon Henriksen1158c532007-12-29 20:45:00 +0000770/* Operations on call sites */
771void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
772unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000773void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
774void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
775 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000776void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
777 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000778
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000779/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000780LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
781void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000782
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000783/* Operations on phi nodes */
784void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
785 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
786unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
787LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
788LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000789
790/*===-- Instruction builders ----------------------------------------------===*/
791
792/* An instruction builder represents a point within a basic block, and is the
793 * exclusive means of building instructions using the C interface.
794 */
795
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000796LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000797LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000798void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
799 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000800void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
801void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000802LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000803void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
804void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000805void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
806 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000807void LLVMDisposeBuilder(LLVMBuilderRef Builder);
808
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000809/* Metadata */
810void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
811LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
812void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
813
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000814/* Terminators */
815LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
816LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000817LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000818 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000819LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
820LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
821 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
822LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
823 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000824LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
825 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000826LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
827 LLVMValueRef *Args, unsigned NumArgs,
828 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
829 const char *Name);
Bill Wendlingf891bf82011-07-31 06:30:59 +0000830LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000831LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
832
Gordon Henriksen097102c2008-01-01 05:50:53 +0000833/* Add a case to the switch instruction */
834void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
835 LLVMBasicBlockRef Dest);
836
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000837/* Add a destination to the indirectbr instruction */
838void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
839
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000840/* Arithmetic */
841LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
842 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000843LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
844 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000845LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
846 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000847LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
848 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000849LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
850 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000851LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
852 const char *Name);
853LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
854 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000855LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
856 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000857LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
858 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000859LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
860 const char *Name);
861LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
862 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000863LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
864 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000865LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
866 const char *Name);
867LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
868 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000869LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
870 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000871LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
872 const char *Name);
873LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
874 const char *Name);
875LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
876 const char *Name);
877LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
878 const char *Name);
879LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
880 const char *Name);
881LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
882 const char *Name);
883LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
884 const char *Name);
885LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
886 const char *Name);
887LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
888 const char *Name);
889LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
890 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000891LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
892 LLVMValueRef LHS, LLVMValueRef RHS,
893 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000894LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000895LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
896 const char *Name);
897LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
898 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000899LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000900LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
901
902/* Memory */
903LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
904LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
905 LLVMValueRef Val, const char *Name);
906LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
907LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
908 LLVMValueRef Val, const char *Name);
909LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
910LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
911 const char *Name);
912LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
913LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
914 LLVMValueRef *Indices, unsigned NumIndices,
915 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000916LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
917 LLVMValueRef *Indices, unsigned NumIndices,
918 const char *Name);
919LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
920 unsigned Idx, const char *Name);
921LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
922 const char *Name);
923LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
924 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000925
926/* Casts */
927LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
928 LLVMTypeRef DestTy, const char *Name);
929LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
930 LLVMTypeRef DestTy, const char *Name);
931LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
932 LLVMTypeRef DestTy, const char *Name);
933LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
934 LLVMTypeRef DestTy, const char *Name);
935LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
936 LLVMTypeRef DestTy, const char *Name);
937LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
938 LLVMTypeRef DestTy, const char *Name);
939LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
940 LLVMTypeRef DestTy, const char *Name);
941LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
942 LLVMTypeRef DestTy, const char *Name);
943LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
944 LLVMTypeRef DestTy, const char *Name);
945LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
946 LLVMTypeRef DestTy, const char *Name);
947LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
948 LLVMTypeRef DestTy, const char *Name);
949LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
950 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000951LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
952 LLVMTypeRef DestTy, const char *Name);
953LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
954 LLVMTypeRef DestTy, const char *Name);
955LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
956 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000957LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
958 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000959LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
960 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000961LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000962 LLVMTypeRef DestTy, const char *Name);
963LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
964 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000965
966/* Comparisons */
967LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
968 LLVMValueRef LHS, LLVMValueRef RHS,
969 const char *Name);
970LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
971 LLVMValueRef LHS, LLVMValueRef RHS,
972 const char *Name);
973
974/* Miscellaneous instructions */
975LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
976LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
977 LLVMValueRef *Args, unsigned NumArgs,
978 const char *Name);
979LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
980 LLVMValueRef Then, LLVMValueRef Else,
981 const char *Name);
982LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
983 const char *Name);
984LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
985 LLVMValueRef Index, const char *Name);
986LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
987 LLVMValueRef EltVal, LLVMValueRef Index,
988 const char *Name);
989LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
990 LLVMValueRef V2, LLVMValueRef Mask,
991 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +0000992LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
993 unsigned Index, const char *Name);
994LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
995 LLVMValueRef EltVal, unsigned Index,
996 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000997
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000998LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
999 const char *Name);
1000LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
1001 const char *Name);
1002LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
1003 LLVMValueRef RHS, const char *Name);
1004
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001005
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001006/*===-- Module providers --------------------------------------------------===*/
1007
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001008/* Changes the type of M so it can be passed to FunctionPassManagers and the
1009 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001010 */
1011LLVMModuleProviderRef
1012LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1013
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001014/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001015 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001016void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001017
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001018
1019/*===-- Memory buffers ----------------------------------------------------===*/
1020
Chris Lattner25963c62010-01-09 22:27:07 +00001021LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1022 LLVMMemoryBufferRef *OutMemBuf,
1023 char **OutMessage);
1024LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1025 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001026void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1027
Owen Anderson4698c5d2010-10-07 17:55:47 +00001028/*===-- Pass Registry -----------------------------------------------------===*/
1029
1030/** Return the global pass registry, for use with initialization functions.
1031 See llvm::PassRegistry::getPassRegistry. */
1032LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001033
1034/*===-- Pass Managers -----------------------------------------------------===*/
1035
1036/** Constructs a new whole-module pass pipeline. This type of pipeline is
1037 suitable for link-time optimization and whole-module transformations.
1038 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001039LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001040
1041/** Constructs a new function-by-function pass pipeline over the module
1042 provider. It does not take ownership of the module provider. This type of
1043 pipeline is suitable for code generation and JIT compilation tasks.
1044 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001045LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1046
1047/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001048LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1049
1050/** Initializes, executes on the provided module, and finalizes all of the
1051 passes scheduled in the pass manager. Returns 1 if any of the passes
1052 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001053LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001054
1055/** Initializes all of the function passes scheduled in the function pass
1056 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1057 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001058LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001059
1060/** Executes all of the function passes scheduled in the function pass manager
1061 on the provided function. Returns 1 if any of the passes modified the
1062 function, false otherwise.
1063 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001064LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001065
1066/** Finalizes all of the function passes scheduled in in the function pass
1067 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1068 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001069LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001070
1071/** Frees the memory of a pass pipeline. For function pipelines, does not free
1072 the module provider.
1073 See llvm::PassManagerBase::~PassManagerBase. */
1074void LLVMDisposePassManager(LLVMPassManagerRef PM);
1075
1076
Gordon Henriksen76a03742007-09-18 03:18:57 +00001077#ifdef __cplusplus
1078}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001079
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001080namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001081 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001082 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001083
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001084 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1085 inline ty *unwrap(ref P) { \
1086 return reinterpret_cast<ty*>(P); \
1087 } \
1088 \
1089 inline ref wrap(const ty *P) { \
1090 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1091 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001092
Gordon Henriksen878114b2008-03-16 04:20:44 +00001093 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1094 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1095 \
1096 template<typename T> \
1097 inline T *unwrap(ref P) { \
1098 return cast<T>(unwrap(P)); \
1099 }
1100
1101 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1102 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1103 \
1104 template<typename T> \
1105 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001106 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001107 assert(Q && "Invalid cast!"); \
1108 return Q; \
1109 }
1110
1111 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1112 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001113 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1114 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001115 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001116 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001117 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001118 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001119 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Owen Anderson4698c5d2010-10-07 17:55:47 +00001120 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001121 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1122 * Module.
1123 */
1124 inline Module *unwrap(LLVMModuleProviderRef MP) {
1125 return reinterpret_cast<Module*>(MP);
1126 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001127
Gordon Henriksen878114b2008-03-16 04:20:44 +00001128 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1129 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001130 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001131
1132 /* Specialized opaque context conversions.
1133 */
1134 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1135 return reinterpret_cast<LLVMContext**>(Tys);
1136 }
1137
1138 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1139 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1140 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001141
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001142 /* Specialized opaque type conversions.
1143 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001144 inline Type **unwrap(LLVMTypeRef* Tys) {
1145 return reinterpret_cast<Type**>(Tys);
1146 }
1147
Chris Lattner229907c2011-07-18 04:54:35 +00001148 inline LLVMTypeRef *wrap(Type **Tys) {
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001149 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1150 }
1151
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001152 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001153 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001154 inline Value **unwrap(LLVMValueRef *Vals) {
1155 return reinterpret_cast<Value**>(Vals);
1156 }
1157
1158 template<typename T>
1159 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1160 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001161 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001162 cast<T>(*I);
1163 #endif
Hans Wennborg8f7edbf2011-06-04 16:00:19 +00001164 (void)Length;
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001165 return reinterpret_cast<T**>(Vals);
1166 }
1167
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001168 inline LLVMValueRef *wrap(const Value **Vals) {
1169 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1170 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001171}
1172
1173#endif /* !defined(__cplusplus) */
1174
1175#endif /* !defined(LLVM_C_CORE_H) */