blob: 74599100e1bae99d8c483a3fbe7174852095b460 [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,
190
191 /* Exception Handling Operators */
192 LLVMLandingPad = 56,
193 LLVMResume = 57
194
Chris Lattner40cf28d2009-10-12 04:01:02 +0000195} LLVMOpcode;
196
197typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000198 LLVMVoidTypeKind, /**< type with no size */
199 LLVMFloatTypeKind, /**< 32 bit floating point type */
200 LLVMDoubleTypeKind, /**< 64 bit floating point type */
201 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
202 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
203 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
204 LLVMLabelTypeKind, /**< Labels */
205 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
206 LLVMFunctionTypeKind, /**< Functions */
207 LLVMStructTypeKind, /**< Structures */
208 LLVMArrayTypeKind, /**< Arrays */
209 LLVMPointerTypeKind, /**< Pointers */
Chris Lattnerdac44ec2009-07-15 22:00:31 +0000210 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
Dale Johannesenbaa5d042010-09-10 20:55:01 +0000211 LLVMMetadataTypeKind, /**< Metadata */
212 LLVMX86_MMXTypeKind /**< X86 MMX */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000213} LLVMTypeKind;
214
215typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000216 LLVMExternalLinkage, /**< Externally visible function */
Chris Lattner2dba0f02009-04-13 06:25:37 +0000217 LLVMAvailableExternallyLinkage,
Duncan Sands12da8ce2009-03-07 15:45:40 +0000218 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
219 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
220 equivalent. */
221 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
222 LLVMWeakODRLinkage, /**< Same, but only replaced by something
223 equivalent. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000224 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
225 LLVMInternalLinkage, /**< Rename collisions when linking (static
226 functions) */
Duncan Sands12da8ce2009-03-07 15:45:40 +0000227 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000228 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
229 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
Duncan Sandse2881052009-03-11 08:08:06 +0000230 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000231 LLVMGhostLinkage, /**< Obsolete */
Bill Wendling002b1672009-07-20 18:22:52 +0000232 LLVMCommonLinkage, /**< Tentative definitions */
Bill Wendling03bcd6e2010-07-01 21:55:59 +0000233 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
Bill Wendling578ee402010-08-20 22:05:50 +0000234 LLVMLinkerPrivateWeakLinkage, /**< Like LinkerPrivate, but is weak. */
235 LLVMLinkerPrivateWeakDefAutoLinkage /**< Like LinkerPrivateWeak, but possibly
236 hidden. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000237} LLVMLinkage;
238
239typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000240 LLVMDefaultVisibility, /**< The GV is visible */
241 LLVMHiddenVisibility, /**< The GV is hidden */
242 LLVMProtectedVisibility /**< The GV is protected */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000243} LLVMVisibility;
244
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000245typedef enum {
246 LLVMCCallConv = 0,
247 LLVMFastCallConv = 8,
248 LLVMColdCallConv = 9,
249 LLVMX86StdcallCallConv = 64,
250 LLVMX86FastcallCallConv = 65
251} LLVMCallConv;
252
253typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000254 LLVMIntEQ = 32, /**< equal */
255 LLVMIntNE, /**< not equal */
256 LLVMIntUGT, /**< unsigned greater than */
257 LLVMIntUGE, /**< unsigned greater or equal */
258 LLVMIntULT, /**< unsigned less than */
259 LLVMIntULE, /**< unsigned less or equal */
260 LLVMIntSGT, /**< signed greater than */
261 LLVMIntSGE, /**< signed greater or equal */
262 LLVMIntSLT, /**< signed less than */
263 LLVMIntSLE /**< signed less or equal */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000264} LLVMIntPredicate;
265
266typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000267 LLVMRealPredicateFalse, /**< Always false (always folded) */
268 LLVMRealOEQ, /**< True if ordered and equal */
269 LLVMRealOGT, /**< True if ordered and greater than */
270 LLVMRealOGE, /**< True if ordered and greater than or equal */
271 LLVMRealOLT, /**< True if ordered and less than */
272 LLVMRealOLE, /**< True if ordered and less than or equal */
273 LLVMRealONE, /**< True if ordered and operands are unequal */
274 LLVMRealORD, /**< True if ordered (no nans) */
275 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
276 LLVMRealUEQ, /**< True if unordered or equal */
277 LLVMRealUGT, /**< True if unordered or greater than */
278 LLVMRealUGE, /**< True if unordered, greater than, or equal */
279 LLVMRealULT, /**< True if unordered or less than */
280 LLVMRealULE, /**< True if unordered, less than, or equal */
281 LLVMRealUNE, /**< True if unordered or not equal */
282 LLVMRealPredicateTrue /**< Always true (always folded) */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000283} LLVMRealPredicate;
284
Bill Wendling6c923bb2011-07-27 20:18:04 +0000285typedef enum {
286 LLVMCatch, /**< A catch clause */
287 LLVMFilter /**< A filter clause */
288} LLVMLandingPadClauseTy;
289
Nick Lewycky0db26542011-05-15 07:20:34 +0000290void LLVMInitializeCore(LLVMPassRegistryRef R);
291
Gordon Henriksen76a03742007-09-18 03:18:57 +0000292
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000293/*===-- Error handling ----------------------------------------------------===*/
294
295void LLVMDisposeMessage(char *Message);
296
297
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000298/*===-- Contexts ----------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000299
Owen Anderson6773d382009-07-01 16:58:40 +0000300/* Create and destroy contexts. */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000301LLVMContextRef LLVMContextCreate(void);
302LLVMContextRef LLVMGetGlobalContext(void);
Owen Anderson6773d382009-07-01 16:58:40 +0000303void LLVMContextDispose(LLVMContextRef C);
304
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000305unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
306 unsigned SLen);
307unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
308
309/*===-- Modules -----------------------------------------------------------===*/
310
Gordon Henriksen76a03742007-09-18 03:18:57 +0000311/* Create and destroy modules. */
Gordon Henriksena49d4352008-03-07 19:13:06 +0000312/** See llvm::Module::Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000313LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Owen Anderson31d44e42009-07-02 07:17:57 +0000314LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
315 LLVMContextRef C);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000316
317/** See llvm::Module::~Module. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000318void LLVMDisposeModule(LLVMModuleRef M);
319
Gordon Henriksena49d4352008-03-07 19:13:06 +0000320/** Data layout. See Module::getDataLayout. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000321const char *LLVMGetDataLayout(LLVMModuleRef M);
322void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
323
Gordon Henriksena49d4352008-03-07 19:13:06 +0000324/** Target triple. See Module::getTargetTriple. */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000325const char *LLVMGetTarget(LLVMModuleRef M);
326void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
327
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000328/** See Module::dump. */
329void LLVMDumpModule(LLVMModuleRef M);
330
Chris Lattner26941452010-04-10 17:52:58 +0000331/** See Module::setModuleInlineAsm. */
332void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000333
Chris Lattnera7e04b02010-11-28 20:03:44 +0000334/** See Module::getContext. */
335LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
336
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000337/*===-- Types -------------------------------------------------------------===*/
Gordon Henriksen76a03742007-09-18 03:18:57 +0000338
339/* LLVM types conform to the following hierarchy:
340 *
341 * types:
342 * integer type
343 * real type
344 * function type
345 * sequence types:
346 * array type
347 * pointer type
348 * vector type
349 * void type
350 * label type
351 * opaque type
352 */
353
Gordon Henriksena49d4352008-03-07 19:13:06 +0000354/** See llvm::LLVMTypeKind::getTypeID. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000355LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000356
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000357/** See llvm::LLVMType::getContext. */
358LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
359
Gordon Henriksen76a03742007-09-18 03:18:57 +0000360/* Operations on integer types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000361LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
362LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
363LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
364LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
365LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
366LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
367
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000368LLVMTypeRef LLVMInt1Type(void);
369LLVMTypeRef LLVMInt8Type(void);
370LLVMTypeRef LLVMInt16Type(void);
371LLVMTypeRef LLVMInt32Type(void);
372LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000373LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000374unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000375
376/* Operations on real types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000377LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
378LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
379LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
380LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
381LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
382
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000383LLVMTypeRef LLVMFloatType(void);
384LLVMTypeRef LLVMDoubleType(void);
385LLVMTypeRef LLVMX86FP80Type(void);
386LLVMTypeRef LLVMFP128Type(void);
387LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000388
389/* Operations on function types */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000390LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
391 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000392 LLVMBool IsVarArg);
393LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000394LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
395unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
396void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000397
398/* Operations on struct types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000399LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000400 unsigned ElementCount, LLVMBool Packed);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000401LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000402 LLVMBool Packed);
Chris Lattnere71ccde2011-07-14 05:53:17 +0000403LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
404void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
405 unsigned ElementCount, LLVMBool Packed);
406
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000407unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000408void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Chris Lattner25963c62010-01-09 22:27:07 +0000409LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Chris Lattner17cf05b2011-07-14 16:20:28 +0000410LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
411
412LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000413
414/* Operations on array, pointer, and vector types (sequence types) */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000415LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000416LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000417LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000418
419LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
420unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000421unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000422unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
423
424/* Operations on other types */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000425LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
426LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000427LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000428
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000429LLVMTypeRef LLVMVoidType(void);
430LLVMTypeRef LLVMLabelType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +0000431LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000432
Gordon Henriksen76a03742007-09-18 03:18:57 +0000433/*===-- Values ------------------------------------------------------------===*/
434
435/* The bulk of LLVM's object model consists of values, which comprise a very
436 * rich type hierarchy.
Gordon Henriksen76a03742007-09-18 03:18:57 +0000437 */
438
Gordon Henriksen29e38942008-12-19 18:39:45 +0000439#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
440 macro(Argument) \
441 macro(BasicBlock) \
442 macro(InlineAsm) \
443 macro(User) \
444 macro(Constant) \
445 macro(ConstantAggregateZero) \
446 macro(ConstantArray) \
447 macro(ConstantExpr) \
448 macro(ConstantFP) \
449 macro(ConstantInt) \
450 macro(ConstantPointerNull) \
451 macro(ConstantStruct) \
452 macro(ConstantVector) \
453 macro(GlobalValue) \
454 macro(Function) \
455 macro(GlobalAlias) \
456 macro(GlobalVariable) \
457 macro(UndefValue) \
458 macro(Instruction) \
459 macro(BinaryOperator) \
460 macro(CallInst) \
461 macro(IntrinsicInst) \
462 macro(DbgInfoIntrinsic) \
463 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000464 macro(EHSelectorInst) \
465 macro(MemIntrinsic) \
466 macro(MemCpyInst) \
467 macro(MemMoveInst) \
468 macro(MemSetInst) \
469 macro(CmpInst) \
470 macro(FCmpInst) \
471 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000472 macro(ExtractElementInst) \
473 macro(GetElementPtrInst) \
474 macro(InsertElementInst) \
475 macro(InsertValueInst) \
Bill Wendling6c923bb2011-07-27 20:18:04 +0000476 macro(LandingPadInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000477 macro(PHINode) \
478 macro(SelectInst) \
479 macro(ShuffleVectorInst) \
480 macro(StoreInst) \
481 macro(TerminatorInst) \
482 macro(BranchInst) \
483 macro(InvokeInst) \
484 macro(ReturnInst) \
485 macro(SwitchInst) \
486 macro(UnreachableInst) \
487 macro(UnwindInst) \
Bill Wendling6c923bb2011-07-27 20:18:04 +0000488 macro(ResumeInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000489 macro(UnaryInstruction) \
Victor Hernandez8acf2952009-10-23 21:09:37 +0000490 macro(AllocaInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +0000491 macro(CastInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000492 macro(BitCastInst) \
493 macro(FPExtInst) \
494 macro(FPToSIInst) \
495 macro(FPToUIInst) \
496 macro(FPTruncInst) \
497 macro(IntToPtrInst) \
498 macro(PtrToIntInst) \
499 macro(SExtInst) \
500 macro(SIToFPInst) \
501 macro(TruncInst) \
502 macro(UIToFPInst) \
503 macro(ZExtInst) \
504 macro(ExtractValueInst) \
Gordon Henriksen05a868f2008-12-19 18:51:17 +0000505 macro(LoadInst) \
506 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +0000507
Gordon Henriksen76a03742007-09-18 03:18:57 +0000508/* Operations on all values */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000509LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000510const char *LLVMGetValueName(LLVMValueRef Val);
511void LLVMSetValueName(LLVMValueRef Val, const char *Name);
Gordon Henriksen1d0d24c2007-10-06 00:08:49 +0000512void LLVMDumpValue(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000513void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000514int LLVMHasMetadata(LLVMValueRef Val);
515LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
516void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000517
Gordon Henriksen29e38942008-12-19 18:39:45 +0000518/* Conversion functions. Return the input value if it is an instance of the
519 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
520#define LLVM_DECLARE_VALUE_CAST(name) \
521 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
522LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
523
Chris Lattner40cf28d2009-10-12 04:01:02 +0000524/* Operations on Uses */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000525LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
526LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
527LLVMValueRef LLVMGetUser(LLVMUseRef U);
528LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000529
530/* Operations on Users */
531LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Erick Tryzelaarb4d48702010-08-20 14:51:22 +0000532void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
533int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000534
Gordon Henriksen76a03742007-09-18 03:18:57 +0000535/* Operations on constants of any type */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000536LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
537LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000538LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Chris Lattner25963c62010-01-09 22:27:07 +0000539LLVMBool LLVMIsConstant(LLVMValueRef Val);
540LLVMBool LLVMIsNull(LLVMValueRef Val);
541LLVMBool LLVMIsUndef(LLVMValueRef Val);
Chris Lattner7f318242009-07-06 17:29:59 +0000542LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000543
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000544/* Operations on metadata */
545LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
546 unsigned SLen);
547LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
548LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
549 unsigned Count);
550LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
551
Gordon Henriksen76a03742007-09-18 03:18:57 +0000552/* Operations on scalar constants */
Gordon Henriksen1046c732007-10-06 15:11:06 +0000553LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +0000554 LLVMBool SignExtend);
Chris Lattner4329e072010-11-23 02:47:22 +0000555LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
556 unsigned NumWords,
557 const uint64_t Words[]);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000558LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
559 uint8_t Radix);
560LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
561 unsigned SLen, uint8_t Radix);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000562LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gordon Henriksen931e1212008-02-02 01:07:50 +0000563LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000564LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
565 unsigned SLen);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000566unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
567long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +0000568
Gordon Henriksen76a03742007-09-18 03:18:57 +0000569
570/* Operations on composite constants */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000571LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +0000572 unsigned Length, LLVMBool DontNullTerminate);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000573LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
574 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +0000575 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000576
Gordon Henriksen1046c732007-10-06 15:11:06 +0000577LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
Chris Lattner25963c62010-01-09 22:27:07 +0000578 LLVMBool DontNullTerminate);
Gordon Henriksen2ad5aef2008-04-25 03:21:19 +0000579LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
Gordon Henriksen1046c732007-10-06 15:11:06 +0000580 LLVMValueRef *ConstantVals, unsigned Length);
581LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +0000582 LLVMBool Packed);
Rafael Espindola784ad242011-07-14 19:09:08 +0000583LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
584 LLVMValueRef *ConstantVals,
585 unsigned Count);
Gordon Henriksen1046c732007-10-06 15:11:06 +0000586LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000587
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000588/* Constant expressions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000589LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000590LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000591LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
592LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000593LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
594LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000595LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000596LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
597LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000598LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000599LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000600LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000601LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000602LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000604LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000605LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000606LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
607LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000608LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000609LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000611LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000612LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
613LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
614LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
615LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
616LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
617LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
618LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
619LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
620 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
621LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
622 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
623LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
624LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
625LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
626LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
627 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000628LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
629 LLVMValueRef *ConstantIndices,
630 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000631LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
632LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
633LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
634LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
635LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
636LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
637LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
638LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
639LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
640LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
641LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
642LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000643LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
644 LLVMTypeRef ToType);
645LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
646 LLVMTypeRef ToType);
647LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
648 LLVMTypeRef ToType);
649LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
650 LLVMTypeRef ToType);
651LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +0000652 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +0000653LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000654LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
655 LLVMValueRef ConstantIfTrue,
656 LLVMValueRef ConstantIfFalse);
657LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
658 LLVMValueRef IndexConstant);
659LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
660 LLVMValueRef ElementValueConstant,
661 LLVMValueRef IndexConstant);
662LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
663 LLVMValueRef VectorBConstant,
664 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +0000665LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
666 unsigned NumIdx);
667LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
668 LLVMValueRef ElementValueConstant,
669 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +0000670LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +0000671 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +0000672 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000673LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +0000674
Gordon Henriksen76a03742007-09-18 03:18:57 +0000675/* Operations on global variables, functions, and aliases (globals) */
Gordon Henriksen265f7802008-03-19 01:11:35 +0000676LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +0000677LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000678LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
679void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
680const char *LLVMGetSection(LLVMValueRef Global);
681void LLVMSetSection(LLVMValueRef Global, const char *Section);
682LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
683void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
684unsigned LLVMGetAlignment(LLVMValueRef Global);
685void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
686
687/* Operations on global variables */
688LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +0000689LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
690 const char *Name,
691 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000692LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000693LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
694LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
695LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
696LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000697void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000698LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
699void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +0000700LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
701void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
702LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
703void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000704
Chris Lattner3d1f5522008-12-17 21:39:50 +0000705/* Operations on aliases */
706LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
707 const char *Name);
708
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000709/* Operations on functions */
710LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
711 LLVMTypeRef FunctionTy);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +0000712LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000713LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
714LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
715LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
716LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000717void LLVMDeleteFunction(LLVMValueRef Fn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000718unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
719unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
720void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gordon Henriksend930f912008-08-17 18:44:35 +0000721const char *LLVMGetGC(LLVMValueRef Fn);
722void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Duncan Sands7374a012009-05-06 12:21:17 +0000723void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000724LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Duncan Sands7374a012009-05-06 12:21:17 +0000725void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000726
Gordon Henriksen265f7802008-03-19 01:11:35 +0000727/* Operations on parameters */
728unsigned LLVMCountParams(LLVMValueRef Fn);
729void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
730LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
731LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000732LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
733LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
734LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
735LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Devang Patel4c758ea2008-09-25 21:00:45 +0000736void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
737void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Chris Lattner40cf28d2009-10-12 04:01:02 +0000738LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000739void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000740
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000741/* Operations on basic blocks */
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000742LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Chris Lattner25963c62010-01-09 22:27:07 +0000743LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000744LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gordon Henriksen07a45f42008-03-23 22:21:29 +0000745LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000746unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
747void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000748LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
749LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
750LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
751LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000752LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000753
754LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
755 LLVMValueRef Fn,
756 const char *Name);
757LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
758 LLVMBasicBlockRef BB,
759 const char *Name);
760
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000761LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
762LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
763 const char *Name);
764void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
765
Duncan Sandsb1d61aa2010-07-19 15:31:07 +0000766void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
767void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
768
Gordon Henriksen265f7802008-03-19 01:11:35 +0000769/* Operations on instructions */
770LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000771LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
772LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
773LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
774LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000775
Gordon Henriksen1158c532007-12-29 20:45:00 +0000776/* Operations on call sites */
777void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
778unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Devang Patel4c758ea2008-09-25 21:00:45 +0000779void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
780void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
781 LLVMAttribute);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000782void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
783 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +0000784
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000785/* Operations on call instructions (only) */
Chris Lattner25963c62010-01-09 22:27:07 +0000786LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
787void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +0000788
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +0000789/* Operations on phi nodes */
790void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
791 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
792unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
793LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
794LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000795
796/*===-- Instruction builders ----------------------------------------------===*/
797
798/* An instruction builder represents a point within a basic block, and is the
799 * exclusive means of building instructions using the C interface.
800 */
801
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000802LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000803LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +0000804void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
805 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000806void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
807void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +0000808LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +0000809void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
810void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +0000811void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
812 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000813void LLVMDisposeBuilder(LLVMBuilderRef Builder);
814
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000815/* Metadata */
816void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
817LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
818void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
819
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000820/* Terminators */
821LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
822LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +0000823LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000824 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000825LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
826LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
827 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
828LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
829 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000830LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
831 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000832LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
833 LLVMValueRef *Args, unsigned NumArgs,
834 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
835 const char *Name);
836LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
Bill Wendling6c923bb2011-07-27 20:18:04 +0000837LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000838LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
839
Gordon Henriksen097102c2008-01-01 05:50:53 +0000840/* Add a case to the switch instruction */
841void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
842 LLVMBasicBlockRef Dest);
843
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +0000844/* Add a destination to the indirectbr instruction */
845void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
846
Bill Wendling6c923bb2011-07-27 20:18:04 +0000847/* Add a clause to the landingpad instruction */
848void LLVMAddClause(LLVMValueRef LandingPad, LLVMLandingPadClauseTy ClauseTy,
849 LLVMValueRef ClauseVal);
850
851/* Set the 'cleanup' flag in the landingpad instruction */
852void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
853
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000854/* Arithmetic */
855LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
856 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000857LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
858 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000859LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
860 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000861LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
862 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000863LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
864 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000865LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
866 const char *Name);
867LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
868 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000869LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
870 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000871LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
872 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000873LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
874 const char *Name);
875LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
876 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000877LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
878 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000879LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
880 const char *Name);
881LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
882 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000883LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
884 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000885LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
886 const char *Name);
887LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
888 const char *Name);
889LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
890 const char *Name);
891LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
892 const char *Name);
893LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
894 const char *Name);
895LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
896 const char *Name);
897LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
898 const char *Name);
899LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
900 const char *Name);
901LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
902 const char *Name);
903LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
904 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000905LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
906 LLVMValueRef LHS, LLVMValueRef RHS,
907 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000908LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +0000909LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
910 const char *Name);
911LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
912 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +0000913LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000914LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
915
916/* Memory */
917LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
918LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
919 LLVMValueRef Val, const char *Name);
920LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
921LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
922 LLVMValueRef Val, const char *Name);
923LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
924LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
925 const char *Name);
926LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
927LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
928 LLVMValueRef *Indices, unsigned NumIndices,
929 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000930LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
931 LLVMValueRef *Indices, unsigned NumIndices,
932 const char *Name);
933LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
934 unsigned Idx, const char *Name);
935LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
936 const char *Name);
937LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
938 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000939
940/* Casts */
941LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
942 LLVMTypeRef DestTy, const char *Name);
943LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
944 LLVMTypeRef DestTy, const char *Name);
945LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
946 LLVMTypeRef DestTy, const char *Name);
947LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
948 LLVMTypeRef DestTy, const char *Name);
949LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
950 LLVMTypeRef DestTy, const char *Name);
951LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
952 LLVMTypeRef DestTy, const char *Name);
953LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
954 LLVMTypeRef DestTy, const char *Name);
955LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
956 LLVMTypeRef DestTy, const char *Name);
957LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
958 LLVMTypeRef DestTy, const char *Name);
959LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
960 LLVMTypeRef DestTy, const char *Name);
961LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
962 LLVMTypeRef DestTy, const char *Name);
963LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
964 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000965LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
966 LLVMTypeRef DestTy, const char *Name);
967LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
968 LLVMTypeRef DestTy, const char *Name);
969LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
970 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +0000971LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
972 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000973LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
974 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +0000975LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +0000976 LLVMTypeRef DestTy, const char *Name);
977LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
978 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000979
980/* Comparisons */
981LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
982 LLVMValueRef LHS, LLVMValueRef RHS,
983 const char *Name);
984LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
985 LLVMValueRef LHS, LLVMValueRef RHS,
986 const char *Name);
987
988/* Miscellaneous instructions */
989LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
990LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
991 LLVMValueRef *Args, unsigned NumArgs,
992 const char *Name);
993LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
994 LLVMValueRef Then, LLVMValueRef Else,
995 const char *Name);
996LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
997 const char *Name);
998LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
999 LLVMValueRef Index, const char *Name);
1000LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
1001 LLVMValueRef EltVal, LLVMValueRef Index,
1002 const char *Name);
1003LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
1004 LLVMValueRef V2, LLVMValueRef Mask,
1005 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +00001006LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
1007 unsigned Index, const char *Name);
1008LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
1009 LLVMValueRef EltVal, unsigned Index,
1010 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001011
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00001012LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
1013 const char *Name);
1014LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
1015 const char *Name);
1016LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
1017 LLVMValueRef RHS, const char *Name);
1018
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001019
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001020/*===-- Module providers --------------------------------------------------===*/
1021
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001022/* Changes the type of M so it can be passed to FunctionPassManagers and the
1023 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001024 */
1025LLVMModuleProviderRef
1026LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1027
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001028/* Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001029 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001030void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001031
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001032
1033/*===-- Memory buffers ----------------------------------------------------===*/
1034
Chris Lattner25963c62010-01-09 22:27:07 +00001035LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1036 LLVMMemoryBufferRef *OutMemBuf,
1037 char **OutMessage);
1038LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1039 char **OutMessage);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001040void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1041
Owen Anderson4698c5d2010-10-07 17:55:47 +00001042/*===-- Pass Registry -----------------------------------------------------===*/
1043
1044/** Return the global pass registry, for use with initialization functions.
1045 See llvm::PassRegistry::getPassRegistry. */
1046LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001047
1048/*===-- Pass Managers -----------------------------------------------------===*/
1049
1050/** Constructs a new whole-module pass pipeline. This type of pipeline is
1051 suitable for link-time optimization and whole-module transformations.
1052 See llvm::PassManager::PassManager. */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001053LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001054
1055/** Constructs a new function-by-function pass pipeline over the module
1056 provider. It does not take ownership of the module provider. This type of
1057 pipeline is suitable for code generation and JIT compilation tasks.
1058 See llvm::FunctionPassManager::FunctionPassManager. */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00001059LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1060
1061/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00001062LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1063
1064/** Initializes, executes on the provided module, and finalizes all of the
1065 passes scheduled in the pass manager. Returns 1 if any of the passes
1066 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001067LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001068
1069/** Initializes all of the function passes scheduled in the function pass
1070 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1071 See llvm::FunctionPassManager::doInitialization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001072LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001073
1074/** Executes all of the function passes scheduled in the function pass manager
1075 on the provided function. Returns 1 if any of the passes modified the
1076 function, false otherwise.
1077 See llvm::FunctionPassManager::run(Function&). */
Chris Lattner25963c62010-01-09 22:27:07 +00001078LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001079
1080/** Finalizes all of the function passes scheduled in in the function pass
1081 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1082 See llvm::FunctionPassManager::doFinalization. */
Chris Lattner25963c62010-01-09 22:27:07 +00001083LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00001084
1085/** Frees the memory of a pass pipeline. For function pipelines, does not free
1086 the module provider.
1087 See llvm::PassManagerBase::~PassManagerBase. */
1088void LLVMDisposePassManager(LLVMPassManagerRef PM);
1089
1090
Gordon Henriksen76a03742007-09-18 03:18:57 +00001091#ifdef __cplusplus
1092}
Gordon Henriksen76a03742007-09-18 03:18:57 +00001093
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001094namespace llvm {
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001095 class MemoryBuffer;
Gordon Henriksen96571492008-03-16 15:55:43 +00001096 class PassManagerBase;
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00001097
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001098 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1099 inline ty *unwrap(ref P) { \
1100 return reinterpret_cast<ty*>(P); \
1101 } \
1102 \
1103 inline ref wrap(const ty *P) { \
1104 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1105 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001106
Gordon Henriksen878114b2008-03-16 04:20:44 +00001107 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1108 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1109 \
1110 template<typename T> \
1111 inline T *unwrap(ref P) { \
1112 return cast<T>(unwrap(P)); \
1113 }
1114
1115 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1116 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1117 \
1118 template<typename T> \
1119 inline T *unwrap(ref P) { \
Chris Lattner7ba06612010-01-22 06:49:46 +00001120 T *Q = (T*)unwrap(P); \
Gordon Henriksen878114b2008-03-16 04:20:44 +00001121 assert(Q && "Invalid cast!"); \
1122 return Q; \
1123 }
1124
1125 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1126 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001127 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1128 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
Eric Christopher59278832008-08-08 19:39:37 +00001129 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
Gordon Henriksen823f9732007-12-27 18:25:59 +00001130 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
Owen Anderson6773d382009-07-01 16:58:40 +00001131 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001132 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
Gordon Henriksen878114b2008-03-16 04:20:44 +00001133 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
Owen Anderson4698c5d2010-10-07 17:55:47 +00001134 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001135 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1136 * Module.
1137 */
1138 inline Module *unwrap(LLVMModuleProviderRef MP) {
1139 return reinterpret_cast<Module*>(MP);
1140 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001141
Gordon Henriksen878114b2008-03-16 04:20:44 +00001142 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1143 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001144 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001145
1146 /* Specialized opaque context conversions.
1147 */
1148 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1149 return reinterpret_cast<LLVMContext**>(Tys);
1150 }
1151
1152 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1153 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1154 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001155
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001156 /* Specialized opaque type conversions.
1157 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001158 inline Type **unwrap(LLVMTypeRef* Tys) {
1159 return reinterpret_cast<Type**>(Tys);
1160 }
1161
Chris Lattner229907c2011-07-18 04:54:35 +00001162 inline LLVMTypeRef *wrap(Type **Tys) {
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001163 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1164 }
1165
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00001166 /* Specialized opaque value conversions.
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001167 */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001168 inline Value **unwrap(LLVMValueRef *Vals) {
1169 return reinterpret_cast<Value**>(Vals);
1170 }
1171
1172 template<typename T>
1173 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1174 #if DEBUG
Chris Lattnerb7971152009-07-10 18:28:19 +00001175 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001176 cast<T>(*I);
1177 #endif
Hans Wennborg8f7edbf2011-06-04 16:00:19 +00001178 (void)Length;
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001179 return reinterpret_cast<T**>(Vals);
1180 }
1181
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001182 inline LLVMValueRef *wrap(const Value **Vals) {
1183 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1184 }
Gordon Henriksen7330acd2007-10-05 23:59:36 +00001185}
1186
1187#endif /* !defined(__cplusplus) */
1188
1189#endif /* !defined(LLVM_C_CORE_H) */