blob: 690ffa9fdc4df4a2c2c187e05d0fbe52062ba281 [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|* *|
Gordon Henriksen76a03742007-09-18 03:18:57 +000013\*===----------------------------------------------------------------------===*/
14
15#ifndef LLVM_C_CORE_H
16#define LLVM_C_CORE_H
17
Michael J. Spencerab425d82010-11-29 18:47:54 +000018#include "llvm/Support/DataTypes.h"
Erick Tryzelaardd991352009-08-16 23:36:46 +000019
Evan Cheng2e254d02013-04-04 17:40:53 +000020#ifdef __cplusplus
Gordon Henriksen76a03742007-09-18 03:18:57 +000021extern "C" {
22#endif
23
Gregory Szorc34c863a2012-03-21 03:54:29 +000024/**
25 * @defgroup LLVMC LLVM-C: C interface to LLVM
26 *
27 * This module exposes parts of the LLVM library as a C API.
28 *
29 * @{
30 */
31
32/**
33 * @defgroup LLVMCTransforms Transforms
34 */
35
36/**
37 * @defgroup LLVMCCore Core
38 *
39 * This modules provide an interface to libLLVMCore, which implements
40 * the LLVM intermediate representation as well as other related types
41 * and utilities.
42 *
43 * LLVM uses a polymorphic type hierarchy which C cannot represent, therefore
44 * parameters must be passed as base types. Despite the declared types, most
45 * of the functions provided operate only on branches of the type hierarchy.
46 * The declared parameter names are descriptive and specify which type is
47 * required. Additionally, each type hierarchy is documented along with the
48 * functions that operate upon it. For more detail, refer to LLVM's C++ code.
Eli Bendersky870d0572012-08-10 18:26:20 +000049 * If in doubt, refer to Core.cpp, which performs parameter downcasts in the
Gregory Szorc34c863a2012-03-21 03:54:29 +000050 * form unwrap<RequiredType>(Param).
51 *
52 * Many exotic languages can interoperate with C code but have a harder time
53 * with C++ due to name mangling. So in addition to C, this interface enables
54 * tools written in such languages.
55 *
Gregory Szorc34c863a2012-03-21 03:54:29 +000056 * @{
57 */
58
59/**
60 * @defgroup LLVMCCoreTypes Types and Enumerations
61 *
62 * @{
63 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000064
Chris Lattner25963c62010-01-09 22:27:07 +000065typedef int LLVMBool;
66
Gordon Henriksen76a03742007-09-18 03:18:57 +000067/* Opaque types. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000068
69/**
Gregory Szorc34c863a2012-03-21 03:54:29 +000070 * The top-level container for all LLVM global data. See the LLVMContext class.
Owen Anderson6773d382009-07-01 16:58:40 +000071 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +000072typedef struct LLVMOpaqueContext *LLVMContextRef;
Owen Anderson6773d382009-07-01 16:58:40 +000073
74/**
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000075 * The top-level container for all other LLVM Intermediate Representation (IR)
Gregory Szorc34c863a2012-03-21 03:54:29 +000076 * objects.
77 *
78 * @see llvm::Module
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000079 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000080typedef struct LLVMOpaqueModule *LLVMModuleRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000081
82/**
Gregory Szorc34c863a2012-03-21 03:54:29 +000083 * Each value in the LLVM IR has a type, an LLVMTypeRef.
84 *
85 * @see llvm::Type
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000086 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000087typedef struct LLVMOpaqueType *LLVMTypeRef;
Gordon Henriksen4a4d7352007-12-30 17:46:33 +000088
Gregory Szorc34c863a2012-03-21 03:54:29 +000089/**
90 * Represents an individual value in LLVM IR.
91 *
92 * This models llvm::Value.
93 */
Gordon Henriksen76a03742007-09-18 03:18:57 +000094typedef struct LLVMOpaqueValue *LLVMValueRef;
Gregory Szorc34c863a2012-03-21 03:54:29 +000095
96/**
Eli Bendersky870d0572012-08-10 18:26:20 +000097 * Represents a basic block of instructions in LLVM IR.
Gregory Szorc34c863a2012-03-21 03:54:29 +000098 *
99 * This models llvm::BasicBlock.
100 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000101typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
Gregory Szorc34c863a2012-03-21 03:54:29 +0000102
103/**
104 * Represents an LLVM basic block builder.
105 *
106 * This models llvm::IRBuilder.
107 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000108typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000109
Gregory Szorc34c863a2012-03-21 03:54:29 +0000110/**
111 * Interface used to provide a module to JIT or interpreter.
112 * This is now just a synonym for llvm::Module, but we have to keep using the
113 * different type to keep binary compatibility.
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000114 */
Gordon Henriksen0a68fe22007-12-12 01:04:30 +0000115typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
Gordon Henriksen76a03742007-09-18 03:18:57 +0000116
Gregory Szorc34c863a2012-03-21 03:54:29 +0000117/**
118 * Used to provide a module to JIT or interpreter.
119 *
120 * @see llvm::MemoryBuffer
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000121 */
122typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
123
Gregory Szorc34c863a2012-03-21 03:54:29 +0000124/** @see llvm::PassManagerBase */
Gordon Henriksen878114b2008-03-16 04:20:44 +0000125typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
126
Gregory Szorc34c863a2012-03-21 03:54:29 +0000127/** @see llvm::PassRegistry */
Owen Anderson4698c5d2010-10-07 17:55:47 +0000128typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef;
129
Gregory Szorc34c863a2012-03-21 03:54:29 +0000130/**
131 * Used to get the users and usees of a Value.
132 *
133 * @see llvm::Use */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +0000134typedef struct LLVMOpaqueUse *LLVMUseRef;
Chris Lattner40cf28d2009-10-12 04:01:02 +0000135
Gordon Henriksen76a03742007-09-18 03:18:57 +0000136typedef enum {
Devang Patel4c758ea2008-09-25 21:00:45 +0000137 LLVMZExtAttribute = 1<<0,
138 LLVMSExtAttribute = 1<<1,
139 LLVMNoReturnAttribute = 1<<2,
140 LLVMInRegAttribute = 1<<3,
141 LLVMStructRetAttribute = 1<<4,
142 LLVMNoUnwindAttribute = 1<<5,
143 LLVMNoAliasAttribute = 1<<6,
144 LLVMByValAttribute = 1<<7,
145 LLVMNestAttribute = 1<<8,
146 LLVMReadNoneAttribute = 1<<9,
Anton Korobeynikovc8ce7b082009-07-17 18:07:26 +0000147 LLVMReadOnlyAttribute = 1<<10,
Anton Korobeynikov9750be92009-07-17 18:57:16 +0000148 LLVMNoInlineAttribute = 1<<11,
149 LLVMAlwaysInlineAttribute = 1<<12,
150 LLVMOptimizeForSizeAttribute = 1<<13,
151 LLVMStackProtectAttribute = 1<<14,
152 LLVMStackProtectReqAttribute = 1<<15,
Erick Tryzelaar8f69fea2010-03-03 23:51:25 +0000153 LLVMAlignment = 31<<16,
Anton Korobeynikov9750be92009-07-17 18:57:16 +0000154 LLVMNoCaptureAttribute = 1<<21,
155 LLVMNoRedZoneAttribute = 1<<22,
156 LLVMNoImplicitFloatAttribute = 1<<23,
Jakob Stoklund Olesen74bb06c2010-02-06 01:16:28 +0000157 LLVMNakedAttribute = 1<<24,
Erick Tryzelaar8f69fea2010-03-03 23:51:25 +0000158 LLVMInlineHintAttribute = 1<<25,
Torok Edwin1db48c02011-10-06 12:13:32 +0000159 LLVMStackAlignment = 7<<26,
160 LLVMReturnsTwice = 1 << 29,
161 LLVMUWTable = 1 << 30,
Chandler Carruth44d69d92012-01-25 07:40:15 +0000162 LLVMNonLazyBind = 1 << 31
163
Bill Wendlingd154e2832013-01-23 06:41:41 +0000164 /* FIXME: These attributes are currently not included in the C API as
Nuno Lopesdef4229972012-09-02 14:19:21 +0000165 a temporary measure until the API/ABI impact to the C API is understood
166 and the path forward agreed upon.
Bill Wendlingd154e2832013-01-23 06:41:41 +0000167 LLVMAddressSafety = 1ULL << 32,
Andrea Di Biagio377496b2013-08-23 11:53:55 +0000168 LLVMStackProtectStrongAttribute = 1ULL<<33,
169 LLVMCold = 1ULL << 34,
170 LLVMOptimizeNone = 1ULL << 35
Nuno Lopesdef4229972012-09-02 14:19:21 +0000171 */
Devang Patel4c758ea2008-09-25 21:00:45 +0000172} LLVMAttribute;
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000173
174typedef enum {
Bill Wendlingda52cec2010-02-15 20:53:17 +0000175 /* Terminator Instructions */
Chris Lattner40cf28d2009-10-12 04:01:02 +0000176 LLVMRet = 1,
177 LLVMBr = 2,
178 LLVMSwitch = 3,
Bill Wendling07d6d762010-02-15 20:50:51 +0000179 LLVMIndirectBr = 4,
180 LLVMInvoke = 5,
Bill Wendling46ffaa92011-08-02 06:20:17 +0000181 /* removed 6 due to API changes */
Bill Wendling2641d132011-07-27 21:00:28 +0000182 LLVMUnreachable = 7,
Bill Wendling07d6d762010-02-15 20:50:51 +0000183
Bill Wendlingda52cec2010-02-15 20:53:17 +0000184 /* Standard Binary Operators */
Bill Wendling2641d132011-07-27 21:00:28 +0000185 LLVMAdd = 8,
186 LLVMFAdd = 9,
187 LLVMSub = 10,
188 LLVMFSub = 11,
189 LLVMMul = 12,
190 LLVMFMul = 13,
191 LLVMUDiv = 14,
192 LLVMSDiv = 15,
193 LLVMFDiv = 16,
194 LLVMURem = 17,
195 LLVMSRem = 18,
196 LLVMFRem = 19,
Bill Wendling07d6d762010-02-15 20:50:51 +0000197
Bill Wendlingda52cec2010-02-15 20:53:17 +0000198 /* Logical Operators */
Bill Wendling2641d132011-07-27 21:00:28 +0000199 LLVMShl = 20,
200 LLVMLShr = 21,
201 LLVMAShr = 22,
202 LLVMAnd = 23,
203 LLVMOr = 24,
204 LLVMXor = 25,
Bill Wendling07d6d762010-02-15 20:50:51 +0000205
Bill Wendlingda52cec2010-02-15 20:53:17 +0000206 /* Memory Operators */
Bill Wendling2641d132011-07-27 21:00:28 +0000207 LLVMAlloca = 26,
208 LLVMLoad = 27,
209 LLVMStore = 28,
210 LLVMGetElementPtr = 29,
Bill Wendling07d6d762010-02-15 20:50:51 +0000211
Bill Wendlingda52cec2010-02-15 20:53:17 +0000212 /* Cast Operators */
Bill Wendling2641d132011-07-27 21:00:28 +0000213 LLVMTrunc = 30,
214 LLVMZExt = 31,
215 LLVMSExt = 32,
216 LLVMFPToUI = 33,
217 LLVMFPToSI = 34,
218 LLVMUIToFP = 35,
219 LLVMSIToFP = 36,
220 LLVMFPTrunc = 37,
221 LLVMFPExt = 38,
222 LLVMPtrToInt = 39,
223 LLVMIntToPtr = 40,
224 LLVMBitCast = 41,
Bill Wendling07d6d762010-02-15 20:50:51 +0000225
Bill Wendlingda52cec2010-02-15 20:53:17 +0000226 /* Other Operators */
Bill Wendling2641d132011-07-27 21:00:28 +0000227 LLVMICmp = 42,
228 LLVMFCmp = 43,
229 LLVMPHI = 44,
230 LLVMCall = 45,
231 LLVMSelect = 46,
Torok Edwin05dc9d62011-10-06 12:39:34 +0000232 LLVMUserOp1 = 47,
233 LLVMUserOp2 = 48,
Bill Wendling2641d132011-07-27 21:00:28 +0000234 LLVMVAArg = 49,
235 LLVMExtractElement = 50,
236 LLVMInsertElement = 51,
237 LLVMShuffleVector = 52,
238 LLVMExtractValue = 53,
239 LLVMInsertValue = 54,
Eli Friedman4fc946c2011-07-27 18:59:19 +0000240
241 /* Atomic operators */
Bill Wendling2641d132011-07-27 21:00:28 +0000242 LLVMFence = 55,
Eli Friedmanc9a551e2011-07-28 21:48:00 +0000243 LLVMAtomicCmpXchg = 56,
Bill Wendlingf891bf82011-07-31 06:30:59 +0000244 LLVMAtomicRMW = 57,
245
246 /* Exception Handling Operators */
Bill Wendlingfae14752011-08-12 20:24:12 +0000247 LLVMResume = 58,
Bill Wendling0aef16a2012-02-06 21:44:22 +0000248 LLVMLandingPad = 59
Bill Wendling2641d132011-07-27 21:00:28 +0000249
Chris Lattner40cf28d2009-10-12 04:01:02 +0000250} LLVMOpcode;
251
252typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000253 LLVMVoidTypeKind, /**< type with no size */
Dan Gohman518cda42011-12-17 00:04:22 +0000254 LLVMHalfTypeKind, /**< 16 bit floating point type */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000255 LLVMFloatTypeKind, /**< 32 bit floating point type */
256 LLVMDoubleTypeKind, /**< 64 bit floating point type */
257 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
258 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
259 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
260 LLVMLabelTypeKind, /**< Labels */
261 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
262 LLVMFunctionTypeKind, /**< Functions */
263 LLVMStructTypeKind, /**< Structures */
264 LLVMArrayTypeKind, /**< Arrays */
265 LLVMPointerTypeKind, /**< Pointers */
Chris Lattnerdac44ec2009-07-15 22:00:31 +0000266 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
Dale Johannesenbaa5d042010-09-10 20:55:01 +0000267 LLVMMetadataTypeKind, /**< Metadata */
268 LLVMX86_MMXTypeKind /**< X86 MMX */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000269} LLVMTypeKind;
270
271typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000272 LLVMExternalLinkage, /**< Externally visible function */
Chris Lattner2dba0f02009-04-13 06:25:37 +0000273 LLVMAvailableExternallyLinkage,
Duncan Sands12da8ce2009-03-07 15:45:40 +0000274 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
275 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
276 equivalent. */
Rafael Espindola716e7402013-11-01 17:09:14 +0000277 LLVMLinkOnceODRAutoHideLinkage, /**< Obsolete */
Duncan Sands12da8ce2009-03-07 15:45:40 +0000278 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
279 LLVMWeakODRLinkage, /**< Same, but only replaced by something
280 equivalent. */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000281 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
282 LLVMInternalLinkage, /**< Rename collisions when linking (static
283 functions) */
Duncan Sands12da8ce2009-03-07 15:45:40 +0000284 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000285 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
286 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
Duncan Sandse2881052009-03-11 08:08:06 +0000287 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000288 LLVMGhostLinkage, /**< Obsolete */
Bill Wendling002b1672009-07-20 18:22:52 +0000289 LLVMCommonLinkage, /**< Tentative definitions */
Bill Wendling03bcd6e2010-07-01 21:55:59 +0000290 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
Bill Wendling34bc34e2012-08-17 18:33:14 +0000291 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000292} LLVMLinkage;
293
294typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000295 LLVMDefaultVisibility, /**< The GV is visible */
296 LLVMHiddenVisibility, /**< The GV is hidden */
297 LLVMProtectedVisibility /**< The GV is protected */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000298} LLVMVisibility;
299
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000300typedef enum {
301 LLVMCCallConv = 0,
302 LLVMFastCallConv = 8,
303 LLVMColdCallConv = 9,
304 LLVMX86StdcallCallConv = 64,
305 LLVMX86FastcallCallConv = 65
306} LLVMCallConv;
307
308typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000309 LLVMIntEQ = 32, /**< equal */
310 LLVMIntNE, /**< not equal */
311 LLVMIntUGT, /**< unsigned greater than */
312 LLVMIntUGE, /**< unsigned greater or equal */
313 LLVMIntULT, /**< unsigned less than */
314 LLVMIntULE, /**< unsigned less or equal */
315 LLVMIntSGT, /**< signed greater than */
316 LLVMIntSGE, /**< signed greater or equal */
317 LLVMIntSLT, /**< signed less than */
318 LLVMIntSLE /**< signed less or equal */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000319} LLVMIntPredicate;
320
321typedef enum {
Gordon Henriksen4a4d7352007-12-30 17:46:33 +0000322 LLVMRealPredicateFalse, /**< Always false (always folded) */
323 LLVMRealOEQ, /**< True if ordered and equal */
324 LLVMRealOGT, /**< True if ordered and greater than */
325 LLVMRealOGE, /**< True if ordered and greater than or equal */
326 LLVMRealOLT, /**< True if ordered and less than */
327 LLVMRealOLE, /**< True if ordered and less than or equal */
328 LLVMRealONE, /**< True if ordered and operands are unequal */
329 LLVMRealORD, /**< True if ordered (no nans) */
330 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
331 LLVMRealUEQ, /**< True if unordered or equal */
332 LLVMRealUGT, /**< True if unordered or greater than */
333 LLVMRealUGE, /**< True if unordered, greater than, or equal */
334 LLVMRealULT, /**< True if unordered or less than */
335 LLVMRealULE, /**< True if unordered, less than, or equal */
336 LLVMRealUNE, /**< True if unordered or not equal */
337 LLVMRealPredicateTrue /**< Always true (always folded) */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000338} LLVMRealPredicate;
339
Bill Wendlingfae14752011-08-12 20:24:12 +0000340typedef enum {
341 LLVMLandingPadCatch, /**< A catch clause */
342 LLVMLandingPadFilter /**< A filter clause */
343} LLVMLandingPadClauseTy;
344
Hans Wennborg5ff71202013-04-16 08:58:59 +0000345typedef enum {
346 LLVMNotThreadLocal = 0,
347 LLVMGeneralDynamicTLSModel,
348 LLVMLocalDynamicTLSModel,
349 LLVMInitialExecTLSModel,
350 LLVMLocalExecTLSModel
351} LLVMThreadLocalMode;
352
Carlo Kokda0ac722013-04-23 13:45:37 +0000353typedef enum {
Carlo Kok8c6719b2013-04-23 13:21:19 +0000354 LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */
355 LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees
356 somewhat sane results, lock free. */
NAKAMURA Takumia3a81352013-10-23 17:56:29 +0000357 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the
358 operations affecting a specific address,
Carlo Kok8c6719b2013-04-23 13:21:19 +0000359 a consistent ordering exists */
NAKAMURA Takumia3a81352013-10-23 17:56:29 +0000360 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort
361 necessary to acquire a lock to access other
Carlo Kok8c6719b2013-04-23 13:21:19 +0000362 memory with normal loads and stores. */
NAKAMURA Takumia3a81352013-10-23 17:56:29 +0000363 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with
364 a barrier of the sort necessary to release
Carlo Kok8c6719b2013-04-23 13:21:19 +0000365 a lock. */
NAKAMURA Takumia3a81352013-10-23 17:56:29 +0000366 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
367 Release barrier (for fences and
Carlo Kok8c6719b2013-04-23 13:21:19 +0000368 operations which both read and write
369 memory). */
NAKAMURA Takumia3a81352013-10-23 17:56:29 +0000370 LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics
371 for loads and Release
372 semantics for stores.
373 Additionally, it guarantees
374 that a total ordering exists
375 between all
376 SequentiallyConsistent
Carlo Kok8c6719b2013-04-23 13:21:19 +0000377 operations. */
Carlo Kokda0ac722013-04-23 13:45:37 +0000378} LLVMAtomicOrdering;
Carlo Kok8c6719b2013-04-23 13:21:19 +0000379
Carlo Kokda0ac722013-04-23 13:45:37 +0000380typedef enum {
Carlo Kok8c6719b2013-04-23 13:21:19 +0000381 LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */
382 LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */
383 LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */
384 LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */
385 LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */
386 LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */
387 LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */
388 LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the
NAKAMURA Takumia3a81352013-10-23 17:56:29 +0000389 original using a signed comparison and return
Carlo Kok8c6719b2013-04-23 13:21:19 +0000390 the old one */
391 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
NAKAMURA Takumia3a81352013-10-23 17:56:29 +0000392 original using a signed comparison and return
Carlo Kok8c6719b2013-04-23 13:21:19 +0000393 the old one */
394 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
NAKAMURA Takumia3a81352013-10-23 17:56:29 +0000395 original using an unsigned comparison and return
Carlo Kok8c6719b2013-04-23 13:21:19 +0000396 the old one */
397 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
NAKAMURA Takumia3a81352013-10-23 17:56:29 +0000398 original using an unsigned comparison and return
Carlo Kok8c6719b2013-04-23 13:21:19 +0000399 the old one */
Carlo Kokda0ac722013-04-23 13:45:37 +0000400} LLVMAtomicRMWBinOp;
Carlo Kok8c6719b2013-04-23 13:21:19 +0000401
Gregory Szorc34c863a2012-03-21 03:54:29 +0000402/**
403 * @}
404 */
405
Nick Lewycky0db26542011-05-15 07:20:34 +0000406void LLVMInitializeCore(LLVMPassRegistryRef R);
407
Duncan Sands1cba0a82013-02-17 16:35:51 +0000408/** Deallocate and destroy all ManagedStatic variables.
409 @see llvm::llvm_shutdown
410 @see ManagedStatic */
Benjamin Kramer325ec892013-10-23 16:57:34 +0000411void LLVMShutdown(void);
Duncan Sands1cba0a82013-02-17 16:35:51 +0000412
Gordon Henriksen76a03742007-09-18 03:18:57 +0000413
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000414/*===-- Error handling ----------------------------------------------------===*/
415
Filip Pizlo3fdbaff2013-05-22 02:46:43 +0000416char *LLVMCreateMessage(const char *Message);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000417void LLVMDisposeMessage(char *Message);
418
Filip Pizloa535b142013-10-17 01:38:28 +0000419typedef void (*LLVMFatalErrorHandler)(const char *Reason);
420
421/**
422 * Install a fatal error handler. By default, if LLVM detects a fatal error, it
423 * will call exit(1). This may not be appropriate in many contexts. For example,
424 * doing exit(1) will bypass many crash reporting/tracing system tools. This
425 * function allows you to install a callback that will be invoked prior to the
426 * call to exit(1).
427 */
428void LLVMInstallFatalErrorHandler(LLVMFatalErrorHandler Handler);
429
430/**
431 * Reset the fatal error handler. This resets LLVM's fatal error handling
432 * behavior to the default.
433 */
434void LLVMResetFatalErrorHandler(void);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +0000435
Gregory Szorc34c863a2012-03-21 03:54:29 +0000436/**
437 * @defgroup LLVMCCoreContext Contexts
438 *
439 * Contexts are execution states for the core LLVM IR system.
440 *
441 * Most types are tied to a context instance. Multiple contexts can
442 * exist simultaneously. A single context is not thread safe. However,
443 * different contexts can execute on different threads simultaneously.
444 *
445 * @{
446 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000447
Gregory Szorc34c863a2012-03-21 03:54:29 +0000448/**
449 * Create a new context.
450 *
451 * Every call to this function should be paired with a call to
452 * LLVMContextDispose() or the context will leak memory.
453 */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000454LLVMContextRef LLVMContextCreate(void);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000455
456/**
457 * Obtain the global context instance.
458 */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000459LLVMContextRef LLVMGetGlobalContext(void);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000460
461/**
462 * Destroy a context instance.
463 *
464 * This should be called for every call to LLVMContextCreate() or memory
465 * will be leaked.
466 */
Owen Anderson6773d382009-07-01 16:58:40 +0000467void LLVMContextDispose(LLVMContextRef C);
468
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000469unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
470 unsigned SLen);
471unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
472
Gregory Szorc34c863a2012-03-21 03:54:29 +0000473/**
474 * @}
475 */
476
Gregory Szorc52d26602012-03-21 07:28:27 +0000477/**
478 * @defgroup LLVMCCoreModule Modules
Gregory Szorc34c863a2012-03-21 03:54:29 +0000479 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +0000480 * Modules represent the top-level structure in an LLVM program. An LLVM
Gregory Szorc34c863a2012-03-21 03:54:29 +0000481 * module is effectively a translation unit or a collection of
482 * translation units merged together.
483 *
484 * @{
485 */
486
Gregory Szorc34c863a2012-03-21 03:54:29 +0000487/**
488 * Create a new, empty module in the global context.
489 *
490 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
491 * LLVMGetGlobalContext() as the context parameter.
492 *
493 * Every invocation should be paired with LLVMDisposeModule() or memory
494 * will be leaked.
495 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000496LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000497
498/**
499 * Create a new, empty module in a specific context.
500 *
501 * Every invocation should be paired with LLVMDisposeModule() or memory
502 * will be leaked.
503 */
Owen Anderson31d44e42009-07-02 07:17:57 +0000504LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
505 LLVMContextRef C);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000506
Gregory Szorc34c863a2012-03-21 03:54:29 +0000507/**
508 * Destroy a module instance.
509 *
510 * This must be called for every created module or memory will be
511 * leaked.
512 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000513void LLVMDisposeModule(LLVMModuleRef M);
514
Gregory Szorc34c863a2012-03-21 03:54:29 +0000515/**
516 * Obtain the data layout for a module.
517 *
518 * @see Module::getDataLayout()
519 */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000520const char *LLVMGetDataLayout(LLVMModuleRef M);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000521
522/**
523 * Set the data layout for a module.
524 *
525 * @see Module::setDataLayout()
526 */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000527void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
528
Gregory Szorc34c863a2012-03-21 03:54:29 +0000529/**
530 * Obtain the target triple for a module.
531 *
532 * @see Module::getTargetTriple()
533 */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000534const char *LLVMGetTarget(LLVMModuleRef M);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000535
536/**
537 * Set the target triple for a module.
538 *
539 * @see Module::setTargetTriple()
540 */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000541void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
542
Gregory Szorc34c863a2012-03-21 03:54:29 +0000543/**
544 * Dump a representation of a module to stderr.
545 *
546 * @see Module::dump()
547 */
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000548void LLVMDumpModule(LLVMModuleRef M);
549
Gregory Szorc34c863a2012-03-21 03:54:29 +0000550/**
Hans Wennborgb7ef2fe2012-05-09 16:54:17 +0000551 * Print a representation of a module to a file. The ErrorMessage needs to be
552 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
553 *
554 * @see Module::print()
555 */
556LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
557 char **ErrorMessage);
558
559/**
Anders Waldenborg84355db2013-10-16 18:00:54 +0000560 * Return a string representation of the module. Use
561 * LLVMDisposeMessage to free the string.
562 *
563 * @see Module::print()
564 */
565char *LLVMPrintModuleToString(LLVMModuleRef M);
566
567/**
Gregory Szorc34c863a2012-03-21 03:54:29 +0000568 * Set inline assembly for a module.
569 *
570 * @see Module::setModuleInlineAsm()
571 */
Chris Lattner26941452010-04-10 17:52:58 +0000572void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000573
Gregory Szorc34c863a2012-03-21 03:54:29 +0000574/**
575 * Obtain the context to which this module is associated.
576 *
577 * @see Module::getContext()
578 */
Chris Lattnera7e04b02010-11-28 20:03:44 +0000579LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
580
Gregory Szorc34c863a2012-03-21 03:54:29 +0000581/**
582 * Obtain a Type from a module by its registered name.
583 */
584LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000585
Gregory Szorc34c863a2012-03-21 03:54:29 +0000586/**
587 * Obtain the number of operands for named metadata in a module.
588 *
589 * @see llvm::Module::getNamedMetadata()
590 */
591unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
592
593/**
594 * Obtain the named metadata operands for a module.
595 *
596 * The passed LLVMValueRef pointer should refer to an array of
597 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
598 * array will be populated with the LLVMValueRef instances. Each
599 * instance corresponds to a llvm::MDNode.
600 *
601 * @see llvm::Module::getNamedMetadata()
602 * @see llvm::MDNode::getOperand()
603 */
604void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
605
606/**
607 * Add an operand to named metadata.
608 *
609 * @see llvm::Module::getNamedMetadata()
610 * @see llvm::MDNode::addOperand()
611 */
612void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
613 LLVMValueRef Val);
614
Gregory Szorc52d26602012-03-21 07:28:27 +0000615/**
616 * Add a function to a module under a specified name.
617 *
618 * @see llvm::Function::Create()
619 */
620LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
621 LLVMTypeRef FunctionTy);
622
623/**
624 * Obtain a Function value from a Module by its name.
625 *
626 * The returned value corresponds to a llvm::Function value.
627 *
628 * @see llvm::Module::getFunction()
629 */
630LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
631
632/**
633 * Obtain an iterator to the first Function in a Module.
634 *
635 * @see llvm::Module::begin()
636 */
637LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
638
639/**
640 * Obtain an iterator to the last Function in a Module.
641 *
642 * @see llvm::Module::end()
643 */
644LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
645
646/**
647 * Advance a Function iterator to the next Function.
648 *
649 * Returns NULL if the iterator was already at the end and there are no more
650 * functions.
651 */
652LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
653
654/**
655 * Decrement a Function iterator to the previous Function.
656 *
657 * Returns NULL if the iterator was already at the beginning and there are
658 * no previous functions.
659 */
660LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000661
662/**
663 * @}
664 */
665
666/**
667 * @defgroup LLVMCCoreType Types
668 *
669 * Types represent the type of a value.
670 *
671 * Types are associated with a context instance. The context internally
672 * deduplicates types so there is only 1 instance of a specific type
673 * alive at a time. In other words, a unique type is shared among all
674 * consumers within a context.
675 *
676 * A Type in the C API corresponds to llvm::Type.
677 *
678 * Types have the following hierarchy:
679 *
Gordon Henriksen76a03742007-09-18 03:18:57 +0000680 * types:
681 * integer type
682 * real type
683 * function type
684 * sequence types:
685 * array type
686 * pointer type
687 * vector type
688 * void type
689 * label type
690 * opaque type
Gregory Szorc34c863a2012-03-21 03:54:29 +0000691 *
692 * @{
Gordon Henriksen76a03742007-09-18 03:18:57 +0000693 */
694
Gregory Szorc34c863a2012-03-21 03:54:29 +0000695/**
696 * Obtain the enumerated type of a Type instance.
697 *
698 * @see llvm::Type:getTypeID()
699 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000700LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000701
702/**
703 * Whether the type has a known size.
704 *
705 * Things that don't have a size are abstract types, labels, and void.a
706 *
707 * @see llvm::Type::isSized()
708 */
Torok Edwin1cd9ade2011-10-06 12:13:28 +0000709LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000710
Gregory Szorc34c863a2012-03-21 03:54:29 +0000711/**
712 * Obtain the context to which this type instance is associated.
713 *
714 * @see llvm::Type::getContext()
715 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000716LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
717
Gregory Szorc34c863a2012-03-21 03:54:29 +0000718/**
Anders Waldenborgb822cff2013-10-16 21:30:25 +0000719 * Dump a representation of a type to stderr.
720 *
721 * @see llvm::Type::dump()
722 */
723void LLVMDumpType(LLVMTypeRef Val);
724
725/**
Anders Waldenborg47b3bd32013-10-22 06:58:34 +0000726 * Return a string representation of the type. Use
727 * LLVMDisposeMessage to free the string.
728 *
729 * @see llvm::Type::print()
730 */
731char *LLVMPrintTypeToString(LLVMTypeRef Val);
732
733/**
Gregory Szorc34c863a2012-03-21 03:54:29 +0000734 * @defgroup LLVMCCoreTypeInt Integer Types
735 *
736 * Functions in this section operate on integer types.
737 *
738 * @{
739 */
740
741/**
742 * Obtain an integer type from a context with specified bit width.
743 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000744LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
745LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
746LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
747LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
748LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
749LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
750
Gregory Szorc34c863a2012-03-21 03:54:29 +0000751/**
752 * Obtain an integer type from the global context with a specified bit
753 * width.
754 */
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000755LLVMTypeRef LLVMInt1Type(void);
756LLVMTypeRef LLVMInt8Type(void);
757LLVMTypeRef LLVMInt16Type(void);
758LLVMTypeRef LLVMInt32Type(void);
759LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000760LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000761unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000762
Gregory Szorc34c863a2012-03-21 03:54:29 +0000763/**
764 * @}
765 */
766
767/**
768 * @defgroup LLVMCCoreTypeFloat Floating Point Types
769 *
770 * @{
771 */
772
773/**
774 * Obtain a 16-bit floating point type from a context.
775 */
Dan Gohman518cda42011-12-17 00:04:22 +0000776LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000777
778/**
779 * Obtain a 32-bit floating point type from a context.
780 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000781LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000782
783/**
784 * Obtain a 64-bit floating point type from a context.
785 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000786LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000787
788/**
789 * Obtain a 80-bit floating point type (X87) from a context.
790 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000791LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000792
793/**
794 * Obtain a 128-bit floating point type (112-bit mantissa) from a
795 * context.
796 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000797LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000798
799/**
800 * Obtain a 128-bit floating point type (two 64-bits) from a context.
801 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000802LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
803
Gregory Szorc34c863a2012-03-21 03:54:29 +0000804/**
805 * Obtain a floating point type from the global context.
806 *
807 * These map to the functions in this group of the same name.
808 */
Dan Gohman518cda42011-12-17 00:04:22 +0000809LLVMTypeRef LLVMHalfType(void);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000810LLVMTypeRef LLVMFloatType(void);
811LLVMTypeRef LLVMDoubleType(void);
812LLVMTypeRef LLVMX86FP80Type(void);
813LLVMTypeRef LLVMFP128Type(void);
814LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000815
Gregory Szorc34c863a2012-03-21 03:54:29 +0000816/**
817 * @}
818 */
819
820/**
821 * @defgroup LLVMCCoreTypeFunction Function Types
822 *
823 * @{
824 */
825
826/**
827 * Obtain a function type consisting of a specified signature.
828 *
829 * The function is defined as a tuple of a return Type, a list of
830 * parameter types, and whether the function is variadic.
831 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000832LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
833 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000834 LLVMBool IsVarArg);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000835
836/**
837 * Returns whether a function type is variadic.
838 */
Chris Lattner25963c62010-01-09 22:27:07 +0000839LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000840
841/**
842 * Obtain the Type this function Type returns.
843 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000844LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000845
846/**
847 * Obtain the number of parameters this function accepts.
848 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000849unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000850
851/**
852 * Obtain the types of a function's parameters.
853 *
854 * The Dest parameter should point to a pre-allocated array of
855 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
856 * first LLVMCountParamTypes() entries in the array will be populated
857 * with LLVMTypeRef instances.
858 *
859 * @param FunctionTy The function type to operate on.
860 * @param Dest Memory address of an array to be filled with result.
861 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000862void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000863
Gregory Szorc34c863a2012-03-21 03:54:29 +0000864/**
865 * @}
866 */
867
868/**
869 * @defgroup LLVMCCoreTypeStruct Structure Types
870 *
871 * These functions relate to LLVMTypeRef instances.
872 *
873 * @see llvm::StructType
874 *
875 * @{
876 */
877
878/**
879 * Create a new structure type in a context.
880 *
881 * A structure is specified by a list of inner elements/types and
882 * whether these can be packed together.
883 *
884 * @see llvm::StructType::create()
885 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000886LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000887 unsigned ElementCount, LLVMBool Packed);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000888
889/**
890 * Create a new structure type in the global context.
891 *
892 * @see llvm::StructType::create()
893 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000894LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000895 LLVMBool Packed);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000896
897/**
898 * Create an empty structure in a context having a specified name.
899 *
900 * @see llvm::StructType::create()
901 */
Chris Lattnere71ccde2011-07-14 05:53:17 +0000902LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000903
904/**
905 * Obtain the name of a structure.
906 *
907 * @see llvm::StructType::getName()
908 */
Torok Edwin0d5f6ae2011-10-06 12:12:50 +0000909const char *LLVMGetStructName(LLVMTypeRef Ty);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000910
911/**
912 * Set the contents of a structure type.
913 *
914 * @see llvm::StructType::setBody()
915 */
Chris Lattnere71ccde2011-07-14 05:53:17 +0000916void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
917 unsigned ElementCount, LLVMBool Packed);
918
Gregory Szorc34c863a2012-03-21 03:54:29 +0000919/**
920 * Get the number of elements defined inside the structure.
921 *
922 * @see llvm::StructType::getNumElements()
923 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000924unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000925
926/**
927 * Get the elements within a structure.
928 *
929 * The function is passed the address of a pre-allocated array of
930 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
931 * invocation, this array will be populated with the structure's
932 * elements. The objects in the destination array will have a lifetime
933 * of the structure type itself, which is the lifetime of the context it
934 * is contained in.
935 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000936void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000937
938/**
939 * Determine whether a structure is packed.
940 *
941 * @see llvm::StructType::isPacked()
942 */
Chris Lattner25963c62010-01-09 22:27:07 +0000943LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000944
945/**
946 * Determine whether a structure is opaque.
947 *
948 * @see llvm::StructType::isOpaque()
949 */
Chris Lattner17cf05b2011-07-14 16:20:28 +0000950LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
951
Gregory Szorc34c863a2012-03-21 03:54:29 +0000952/**
953 * @}
954 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000955
Gregory Szorc34c863a2012-03-21 03:54:29 +0000956
957/**
958 * @defgroup LLVMCCoreTypeSequential Sequential Types
959 *
960 * Sequential types represents "arrays" of types. This is a super class
961 * for array, vector, and pointer types.
962 *
963 * @{
964 */
965
966/**
967 * Obtain the type of elements within a sequential type.
968 *
969 * This works on array, vector, and pointer types.
970 *
971 * @see llvm::SequentialType::getElementType()
972 */
973LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
974
975/**
976 * Create a fixed size array type that refers to a specific type.
977 *
978 * The created type will exist in the context that its element type
979 * exists in.
980 *
981 * @see llvm::ArrayType::get()
982 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000983LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000984
985/**
986 * Obtain the length of an array type.
987 *
988 * This only works on types that represent arrays.
989 *
990 * @see llvm::ArrayType::getNumElements()
991 */
992unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
993
994/**
995 * Create a pointer type that points to a defined type.
996 *
997 * The created type will exist in the context that its pointee type
998 * exists in.
999 *
1000 * @see llvm::PointerType::get()
1001 */
Gordon Henriksen5a3fe032007-12-17 16:08:32 +00001002LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001003
1004/**
1005 * Obtain the address space of a pointer type.
1006 *
1007 * This only works on types that represent pointers.
1008 *
1009 * @see llvm::PointerType::getAddressSpace()
1010 */
1011unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
1012
1013/**
1014 * Create a vector type that contains a defined type and has a specific
1015 * number of elements.
1016 *
1017 * The created type will exist in the context thats its element type
1018 * exists in.
1019 *
1020 * @see llvm::VectorType::get()
1021 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +00001022LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001023
Gregory Szorc34c863a2012-03-21 03:54:29 +00001024/**
1025 * Obtain the number of elements in a vector type.
1026 *
1027 * This only works on types that represent vectors.
1028 *
1029 * @see llvm::VectorType::getNumElements()
1030 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001031unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1032
Gregory Szorc34c863a2012-03-21 03:54:29 +00001033/**
1034 * @}
1035 */
1036
1037/**
1038 * @defgroup LLVMCCoreTypeOther Other Types
1039 *
1040 * @{
1041 */
1042
1043/**
1044 * Create a void type in a context.
1045 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001046LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001047
1048/**
1049 * Create a label type in a context.
1050 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001051LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001052
1053/**
1054 * Create a X86 MMX type in a context.
1055 */
Dale Johannesen95b67af2010-09-10 21:58:02 +00001056LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001057
Gregory Szorc34c863a2012-03-21 03:54:29 +00001058/**
1059 * These are similar to the above functions except they operate on the
1060 * global context.
1061 */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001062LLVMTypeRef LLVMVoidType(void);
1063LLVMTypeRef LLVMLabelType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +00001064LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001065
Gregory Szorc34c863a2012-03-21 03:54:29 +00001066/**
1067 * @}
1068 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001069
Gregory Szorc34c863a2012-03-21 03:54:29 +00001070/**
1071 * @}
1072 */
1073
1074/**
1075 * @defgroup LLVMCCoreValues Values
1076 *
1077 * The bulk of LLVM's object model consists of values, which comprise a very
Gordon Henriksen76a03742007-09-18 03:18:57 +00001078 * rich type hierarchy.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001079 *
1080 * LLVMValueRef essentially represents llvm::Value. There is a rich
1081 * hierarchy of classes within this type. Depending on the instance
Eli Benderskyc52863c2012-08-10 18:30:44 +00001082 * obtained, not all APIs are available.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001083 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001084 * Callers can determine the type of an LLVMValueRef by calling the
Gregory Szorc34c863a2012-03-21 03:54:29 +00001085 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1086 * functions are defined by a macro, so it isn't obvious which are
1087 * available by looking at the Doxygen source code. Instead, look at the
1088 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1089 * of value names given. These value names also correspond to classes in
1090 * the llvm::Value hierarchy.
1091 *
1092 * @{
Gordon Henriksen76a03742007-09-18 03:18:57 +00001093 */
1094
Gordon Henriksen29e38942008-12-19 18:39:45 +00001095#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1096 macro(Argument) \
1097 macro(BasicBlock) \
1098 macro(InlineAsm) \
Torok Edwind09b7572011-10-14 20:37:56 +00001099 macro(MDNode) \
1100 macro(MDString) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001101 macro(User) \
1102 macro(Constant) \
Torok Edwind09b7572011-10-14 20:37:56 +00001103 macro(BlockAddress) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001104 macro(ConstantAggregateZero) \
1105 macro(ConstantArray) \
1106 macro(ConstantExpr) \
1107 macro(ConstantFP) \
1108 macro(ConstantInt) \
1109 macro(ConstantPointerNull) \
1110 macro(ConstantStruct) \
1111 macro(ConstantVector) \
1112 macro(GlobalValue) \
1113 macro(Function) \
1114 macro(GlobalAlias) \
1115 macro(GlobalVariable) \
1116 macro(UndefValue) \
1117 macro(Instruction) \
1118 macro(BinaryOperator) \
1119 macro(CallInst) \
1120 macro(IntrinsicInst) \
1121 macro(DbgInfoIntrinsic) \
1122 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001123 macro(MemIntrinsic) \
1124 macro(MemCpyInst) \
1125 macro(MemMoveInst) \
1126 macro(MemSetInst) \
1127 macro(CmpInst) \
Torok Edwind09b7572011-10-14 20:37:56 +00001128 macro(FCmpInst) \
1129 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001130 macro(ExtractElementInst) \
1131 macro(GetElementPtrInst) \
1132 macro(InsertElementInst) \
1133 macro(InsertValueInst) \
Bill Wendlingfae14752011-08-12 20:24:12 +00001134 macro(LandingPadInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001135 macro(PHINode) \
1136 macro(SelectInst) \
1137 macro(ShuffleVectorInst) \
1138 macro(StoreInst) \
1139 macro(TerminatorInst) \
1140 macro(BranchInst) \
Torok Edwind09b7572011-10-14 20:37:56 +00001141 macro(IndirectBrInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001142 macro(InvokeInst) \
1143 macro(ReturnInst) \
1144 macro(SwitchInst) \
1145 macro(UnreachableInst) \
Bill Wendlingf891bf82011-07-31 06:30:59 +00001146 macro(ResumeInst) \
Duncan Sands5e37e992013-05-06 08:55:45 +00001147 macro(UnaryInstruction) \
1148 macro(AllocaInst) \
1149 macro(CastInst) \
1150 macro(BitCastInst) \
1151 macro(FPExtInst) \
1152 macro(FPToSIInst) \
1153 macro(FPToUIInst) \
1154 macro(FPTruncInst) \
1155 macro(IntToPtrInst) \
1156 macro(PtrToIntInst) \
1157 macro(SExtInst) \
1158 macro(SIToFPInst) \
1159 macro(TruncInst) \
1160 macro(UIToFPInst) \
1161 macro(ZExtInst) \
1162 macro(ExtractValueInst) \
1163 macro(LoadInst) \
1164 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +00001165
Gregory Szorc34c863a2012-03-21 03:54:29 +00001166/**
1167 * @defgroup LLVMCCoreValueGeneral General APIs
1168 *
1169 * Functions in this section work on all LLVMValueRef instances,
1170 * regardless of their sub-type. They correspond to functions available
1171 * on llvm::Value.
1172 *
1173 * @{
1174 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001175
Gregory Szorc34c863a2012-03-21 03:54:29 +00001176/**
1177 * Obtain the type of a value.
1178 *
1179 * @see llvm::Value::getType()
1180 */
1181LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1182
1183/**
1184 * Obtain the string name of a value.
1185 *
1186 * @see llvm::Value::getName()
1187 */
1188const char *LLVMGetValueName(LLVMValueRef Val);
1189
1190/**
1191 * Set the string name of a value.
1192 *
1193 * @see llvm::Value::setName()
1194 */
1195void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1196
1197/**
1198 * Dump a representation of a value to stderr.
1199 *
1200 * @see llvm::Value::dump()
1201 */
1202void LLVMDumpValue(LLVMValueRef Val);
1203
1204/**
1205 * Replace all uses of a value with another one.
1206 *
1207 * @see llvm::Value::replaceAllUsesWith()
1208 */
1209void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1210
1211/**
1212 * Determine whether the specified constant instance is constant.
1213 */
1214LLVMBool LLVMIsConstant(LLVMValueRef Val);
1215
1216/**
1217 * Determine whether a value instance is undefined.
1218 */
1219LLVMBool LLVMIsUndef(LLVMValueRef Val);
1220
1221/**
1222 * Convert value instances between types.
1223 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001224 * Internally, an LLVMValueRef is "pinned" to a specific type. This
Gregory Szorc34c863a2012-03-21 03:54:29 +00001225 * series of functions allows you to cast an instance to a specific
1226 * type.
1227 *
1228 * If the cast is not valid for the specified type, NULL is returned.
1229 *
1230 * @see llvm::dyn_cast_or_null<>
1231 */
Gordon Henriksen29e38942008-12-19 18:39:45 +00001232#define LLVM_DECLARE_VALUE_CAST(name) \
1233 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1234LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1235
Gregory Szorc34c863a2012-03-21 03:54:29 +00001236/**
1237 * @}
1238 */
1239
1240/**
1241 * @defgroup LLVMCCoreValueUses Usage
1242 *
1243 * This module defines functions that allow you to inspect the uses of a
1244 * LLVMValueRef.
1245 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001246 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001247 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1248 * llvm::User and llvm::Value.
1249 *
1250 * @{
1251 */
1252
1253/**
1254 * Obtain the first use of a value.
1255 *
1256 * Uses are obtained in an iterator fashion. First, call this function
1257 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
Eli Benderskyc52863c2012-08-10 18:30:44 +00001258 * on that instance and all subsequently obtained instances until
Gregory Szorc34c863a2012-03-21 03:54:29 +00001259 * LLVMGetNextUse() returns NULL.
1260 *
1261 * @see llvm::Value::use_begin()
1262 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001263LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001264
1265/**
1266 * Obtain the next use of a value.
1267 *
1268 * This effectively advances the iterator. It returns NULL if you are on
1269 * the final use and no more are available.
1270 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001271LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001272
1273/**
1274 * Obtain the user value for a user.
1275 *
1276 * The returned value corresponds to a llvm::User type.
1277 *
1278 * @see llvm::Use::getUser()
1279 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001280LLVMValueRef LLVMGetUser(LLVMUseRef U);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001281
1282/**
1283 * Obtain the value this use corresponds to.
1284 *
1285 * @see llvm::Use::get().
1286 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001287LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +00001288
Gregory Szorc34c863a2012-03-21 03:54:29 +00001289/**
1290 * @}
1291 */
1292
1293/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001294 * @defgroup LLVMCCoreValueUser User value
Gregory Szorc34c863a2012-03-21 03:54:29 +00001295 *
1296 * Function in this group pertain to LLVMValueRef instances that descent
1297 * from llvm::User. This includes constants, instructions, and
1298 * operators.
1299 *
1300 * @{
1301 */
1302
1303/**
1304 * Obtain an operand at a specific index in a llvm::User value.
1305 *
1306 * @see llvm::User::getOperand()
1307 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001308LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001309
1310/**
1311 * Set an operand at a specific index in a llvm::User value.
1312 *
1313 * @see llvm::User::setOperand()
1314 */
Erick Tryzelaarb4d48702010-08-20 14:51:22 +00001315void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001316
1317/**
1318 * Obtain the number of operands in a llvm::User value.
1319 *
1320 * @see llvm::User::getNumOperands()
1321 */
Erick Tryzelaarb4d48702010-08-20 14:51:22 +00001322int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +00001323
Gregory Szorc34c863a2012-03-21 03:54:29 +00001324/**
1325 * @}
1326 */
1327
1328/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001329 * @defgroup LLVMCCoreValueConstant Constants
Gregory Szorc34c863a2012-03-21 03:54:29 +00001330 *
1331 * This section contains APIs for interacting with LLVMValueRef that
1332 * correspond to llvm::Constant instances.
1333 *
1334 * These functions will work for any LLVMValueRef in the llvm::Constant
1335 * class hierarchy.
1336 *
1337 * @{
1338 */
1339
1340/**
1341 * Obtain a constant value referring to the null instance of a type.
1342 *
1343 * @see llvm::Constant::getNullValue()
1344 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001345LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
Gregory Szorc34c863a2012-03-21 03:54:29 +00001346
1347/**
1348 * Obtain a constant value referring to the instance of a type
1349 * consisting of all ones.
1350 *
1351 * This is only valid for integer types.
1352 *
1353 * @see llvm::Constant::getAllOnesValue()
1354 */
1355LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1356
1357/**
1358 * Obtain a constant value referring to an undefined value of a type.
1359 *
1360 * @see llvm::UndefValue::get()
1361 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001362LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001363
1364/**
1365 * Determine whether a value instance is null.
1366 *
1367 * @see llvm::Constant::isNullValue()
1368 */
Chris Lattner25963c62010-01-09 22:27:07 +00001369LLVMBool LLVMIsNull(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001370
1371/**
1372 * Obtain a constant that is a constant pointer pointing to NULL for a
1373 * specified type.
1374 */
Chris Lattner7f318242009-07-06 17:29:59 +00001375LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001376
Gregory Szorc34c863a2012-03-21 03:54:29 +00001377/**
1378 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1379 *
1380 * Functions in this group model LLVMValueRef instances that correspond
1381 * to constants referring to scalar types.
1382 *
1383 * For integer types, the LLVMTypeRef parameter should correspond to a
1384 * llvm::IntegerType instance and the returned LLVMValueRef will
1385 * correspond to a llvm::ConstantInt.
1386 *
1387 * For floating point types, the LLVMTypeRef returned corresponds to a
1388 * llvm::ConstantFP.
1389 *
1390 * @{
1391 */
Erick Tryzelaard8531fa2010-02-28 09:45:59 +00001392
Gregory Szorc34c863a2012-03-21 03:54:29 +00001393/**
1394 * Obtain a constant value for an integer type.
1395 *
1396 * The returned value corresponds to a llvm::ConstantInt.
1397 *
1398 * @see llvm::ConstantInt::get()
1399 *
1400 * @param IntTy Integer type to obtain value of.
1401 * @param N The value the returned instance should refer to.
1402 * @param SignExtend Whether to sign extend the produced value.
1403 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001404LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +00001405 LLVMBool SignExtend);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001406
1407/**
1408 * Obtain a constant value for an integer of arbitrary precision.
1409 *
1410 * @see llvm::ConstantInt::get()
1411 */
Chris Lattner4329e072010-11-23 02:47:22 +00001412LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1413 unsigned NumWords,
1414 const uint64_t Words[]);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001415
1416/**
1417 * Obtain a constant value for an integer parsed from a string.
1418 *
1419 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1420 * string's length is available, it is preferred to call that function
1421 * instead.
1422 *
1423 * @see llvm::ConstantInt::get()
1424 */
Erick Tryzelaardd991352009-08-16 23:36:46 +00001425LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1426 uint8_t Radix);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001427
1428/**
1429 * Obtain a constant value for an integer parsed from a string with
1430 * specified length.
1431 *
1432 * @see llvm::ConstantInt::get()
1433 */
Erick Tryzelaardd991352009-08-16 23:36:46 +00001434LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1435 unsigned SLen, uint8_t Radix);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001436
1437/**
1438 * Obtain a constant value referring to a double floating point value.
1439 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001440LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001441
1442/**
1443 * Obtain a constant for a floating point value parsed from a string.
1444 *
1445 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1446 * should be used if the input string's length is known.
1447 */
Gordon Henriksen931e1212008-02-02 01:07:50 +00001448LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001449
1450/**
1451 * Obtain a constant for a floating point value parsed from a string.
1452 */
Erick Tryzelaardd991352009-08-16 23:36:46 +00001453LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1454 unsigned SLen);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001455
1456/**
1457 * Obtain the zero extended value for an integer constant value.
1458 *
1459 * @see llvm::ConstantInt::getZExtValue()
1460 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001461unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001462
1463/**
1464 * Obtain the sign extended value for an integer constant value.
1465 *
1466 * @see llvm::ConstantInt::getSExtValue()
1467 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001468long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +00001469
Gregory Szorc34c863a2012-03-21 03:54:29 +00001470/**
1471 * @}
1472 */
1473
1474/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001475 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1476 *
1477 * Functions in this group operate on composite constants.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001478 *
1479 * @{
1480 */
1481
1482/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001483 * Create a ConstantDataSequential and initialize it with a string.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001484 *
Gregory Szorc52d26602012-03-21 07:28:27 +00001485 * @see llvm::ConstantDataArray::getString()
Gregory Szorc34c863a2012-03-21 03:54:29 +00001486 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001487LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +00001488 unsigned Length, LLVMBool DontNullTerminate);
Gregory Szorc52d26602012-03-21 07:28:27 +00001489
1490/**
1491 * Create a ConstantDataSequential with string content in the global context.
1492 *
1493 * This is the same as LLVMConstStringInContext except it operates on the
1494 * global context.
1495 *
1496 * @see LLVMConstStringInContext()
1497 * @see llvm::ConstantDataArray::getString()
1498 */
1499LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1500 LLVMBool DontNullTerminate);
1501
1502/**
1503 * Create an anonymous ConstantStruct with the specified values.
1504 *
1505 * @see llvm::ConstantStruct::getAnon()
1506 */
1507LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001508 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +00001509 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001510
Gregory Szorc52d26602012-03-21 07:28:27 +00001511/**
1512 * Create a ConstantStruct in the global Context.
1513 *
1514 * This is the same as LLVMConstStructInContext except it operates on the
1515 * global Context.
1516 *
1517 * @see LLVMConstStructInContext()
1518 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001519LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +00001520 LLVMBool Packed);
Gregory Szorc52d26602012-03-21 07:28:27 +00001521
1522/**
1523 * Create a ConstantArray from values.
1524 *
1525 * @see llvm::ConstantArray::get()
1526 */
1527LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1528 LLVMValueRef *ConstantVals, unsigned Length);
1529
1530/**
1531 * Create a non-anonymous ConstantStruct from values.
1532 *
1533 * @see llvm::ConstantStruct::get()
1534 */
Rafael Espindola784ad242011-07-14 19:09:08 +00001535LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1536 LLVMValueRef *ConstantVals,
1537 unsigned Count);
Gregory Szorc52d26602012-03-21 07:28:27 +00001538
1539/**
1540 * Create a ConstantVector from values.
1541 *
1542 * @see llvm::ConstantVector::get()
1543 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001544LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001545
Gregory Szorc52d26602012-03-21 07:28:27 +00001546/**
1547 * @}
1548 */
1549
1550/**
1551 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1552 *
1553 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1554 *
1555 * @see llvm::ConstantExpr.
1556 *
1557 * @{
1558 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001559LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +00001560LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001561LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1562LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001563LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1564LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001565LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001566LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1567LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +00001568LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001569LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001570LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001571LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001572LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1573LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001574LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001575LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001576LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1577LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001578LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001579LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1580LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +00001581LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001582LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1583LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1584LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1585LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1586LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1587LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1588LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1589LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1590 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1591LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1592 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1593LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1594LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1595LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1596LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1597 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +00001598LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1599 LLVMValueRef *ConstantIndices,
1600 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001601LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1602LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1603LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1604LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1605LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1606LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1607LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1608LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1609LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1610LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1611LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1612LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001613LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1614 LLVMTypeRef ToType);
1615LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1616 LLVMTypeRef ToType);
1617LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1618 LLVMTypeRef ToType);
1619LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1620 LLVMTypeRef ToType);
1621LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +00001622 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001623LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001624LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1625 LLVMValueRef ConstantIfTrue,
1626 LLVMValueRef ConstantIfFalse);
1627LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1628 LLVMValueRef IndexConstant);
1629LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1630 LLVMValueRef ElementValueConstant,
1631 LLVMValueRef IndexConstant);
1632LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1633 LLVMValueRef VectorBConstant,
1634 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +00001635LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1636 unsigned NumIdx);
1637LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1638 LLVMValueRef ElementValueConstant,
1639 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +00001640LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +00001641 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +00001642 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +00001643LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001644
Gregory Szorc52d26602012-03-21 07:28:27 +00001645/**
1646 * @}
1647 */
1648
1649/**
1650 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1651 *
1652 * This group contains functions that operate on global values. Functions in
1653 * this group relate to functions in the llvm::GlobalValue class tree.
1654 *
1655 * @see llvm::GlobalValue
1656 *
1657 * @{
1658 */
1659
Gordon Henriksen265f7802008-03-19 01:11:35 +00001660LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +00001661LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001662LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1663void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1664const char *LLVMGetSection(LLVMValueRef Global);
1665void LLVMSetSection(LLVMValueRef Global, const char *Section);
1666LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1667void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
Anders Waldenborg213a63f2013-10-29 09:02:02 +00001668
1669/**
1670 * @defgroup LLVMCCoreValueWithAlignment Values with alignment
1671 *
1672 * Functions in this group only apply to values with alignment, i.e.
1673 * global variables, load and store instructions.
1674 */
1675
1676/**
1677 * Obtain the preferred alignment of the value.
1678 * @see llvm::LoadInst::getAlignment()
1679 * @see llvm::StoreInst::getAlignment()
1680 * @see llvm::GlobalValue::getAlignment()
1681 */
1682unsigned LLVMGetAlignment(LLVMValueRef V);
1683
1684/**
1685 * Set the preferred alignment of the value.
1686 * @see llvm::LoadInst::setAlignment()
1687 * @see llvm::StoreInst::setAlignment()
1688 * @see llvm::GlobalValue::setAlignment()
1689 */
1690void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes);
1691
1692/**
1693 * @}
1694 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001695
Gregory Szorc52d26602012-03-21 07:28:27 +00001696/**
1697 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1698 *
1699 * This group contains functions that operate on global variable values.
1700 *
1701 * @see llvm::GlobalVariable
1702 *
1703 * @{
1704 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001705LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +00001706LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1707 const char *Name,
1708 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +00001709LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001710LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1711LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1712LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1713LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001714void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001715LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1716void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +00001717LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1718void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1719LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1720void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Hans Wennborg5ff71202013-04-16 08:58:59 +00001721LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1722void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1723LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1724void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001725
Gregory Szorc52d26602012-03-21 07:28:27 +00001726/**
1727 * @}
1728 */
1729
1730/**
1731 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1732 *
1733 * This group contains function that operate on global alias values.
1734 *
1735 * @see llvm::GlobalAlias
1736 *
1737 * @{
1738 */
Chris Lattner3d1f5522008-12-17 21:39:50 +00001739LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1740 const char *Name);
1741
Gregory Szorc34c863a2012-03-21 03:54:29 +00001742/**
1743 * @}
1744 */
1745
1746/**
1747 * @defgroup LLVMCCoreValueFunction Function values
1748 *
1749 * Functions in this group operate on LLVMValueRef instances that
1750 * correspond to llvm::Function instances.
1751 *
1752 * @see llvm::Function
1753 *
1754 * @{
1755 */
1756
1757/**
1758 * Remove a function from its containing module and deletes it.
1759 *
1760 * @see llvm::Function::eraseFromParent()
1761 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001762void LLVMDeleteFunction(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001763
1764/**
1765 * Obtain the ID number from a function instance.
1766 *
1767 * @see llvm::Function::getIntrinsicID()
1768 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001769unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001770
1771/**
1772 * Obtain the calling function of a function.
1773 *
1774 * The returned value corresponds to the LLVMCallConv enumeration.
1775 *
1776 * @see llvm::Function::getCallingConv()
1777 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001778unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001779
1780/**
1781 * Set the calling convention of a function.
1782 *
1783 * @see llvm::Function::setCallingConv()
1784 *
1785 * @param Fn Function to operate on
1786 * @param CC LLVMCallConv to set calling convention to
1787 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001788void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001789
1790/**
1791 * Obtain the name of the garbage collector to use during code
1792 * generation.
1793 *
1794 * @see llvm::Function::getGC()
1795 */
Gordon Henriksend930f912008-08-17 18:44:35 +00001796const char *LLVMGetGC(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001797
1798/**
1799 * Define the garbage collector to use during code generation.
1800 *
1801 * @see llvm::Function::setGC()
1802 */
Gordon Henriksend930f912008-08-17 18:44:35 +00001803void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001804
1805/**
1806 * Add an attribute to a function.
1807 *
1808 * @see llvm::Function::addAttribute()
1809 */
Duncan Sands7374a012009-05-06 12:21:17 +00001810void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001811
1812/**
Tom Stellarde8f35e12013-04-16 23:12:43 +00001813 * Add a target-dependent attribute to a fuction
1814 * @see llvm::AttrBuilder::addAttribute()
1815 */
1816void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1817 const char *V);
1818
1819/**
Gregory Szorc34c863a2012-03-21 03:54:29 +00001820 * Obtain an attribute from a function.
1821 *
1822 * @see llvm::Function::getAttributes()
1823 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001824LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001825
1826/**
1827 * Remove an attribute from a function.
1828 */
Duncan Sands7374a012009-05-06 12:21:17 +00001829void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001830
Gregory Szorc34c863a2012-03-21 03:54:29 +00001831/**
1832 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1833 *
1834 * Functions in this group relate to arguments/parameters on functions.
1835 *
1836 * Functions in this group expect LLVMValueRef instances that correspond
1837 * to llvm::Function instances.
1838 *
1839 * @{
1840 */
1841
1842/**
1843 * Obtain the number of parameters in a function.
1844 *
1845 * @see llvm::Function::arg_size()
1846 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001847unsigned LLVMCountParams(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001848
1849/**
1850 * Obtain the parameters in a function.
1851 *
1852 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1853 * at least LLVMCountParams() long. This array will be filled with
1854 * LLVMValueRef instances which correspond to the parameters the
1855 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1856 * instance.
1857 *
1858 * @see llvm::Function::arg_begin()
1859 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001860void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001861
1862/**
1863 * Obtain the parameter at the specified index.
1864 *
1865 * Parameters are indexed from 0.
1866 *
1867 * @see llvm::Function::arg_begin()
1868 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001869LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001870
1871/**
1872 * Obtain the function to which this argument belongs.
1873 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001874 * Unlike other functions in this group, this one takes an LLVMValueRef
Gregory Szorc34c863a2012-03-21 03:54:29 +00001875 * that corresponds to a llvm::Attribute.
1876 *
1877 * The returned LLVMValueRef is the llvm::Function to which this
1878 * argument belongs.
1879 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001880LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001881
1882/**
1883 * Obtain the first parameter to a function.
1884 *
1885 * @see llvm::Function::arg_begin()
1886 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001887LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001888
1889/**
1890 * Obtain the last parameter to a function.
1891 *
1892 * @see llvm::Function::arg_end()
1893 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001894LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001895
1896/**
1897 * Obtain the next parameter to a function.
1898 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001899 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
Gregory Szorc34c863a2012-03-21 03:54:29 +00001900 * actually a wrapped iterator) and obtains the next parameter from the
1901 * underlying iterator.
1902 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001903LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001904
1905/**
1906 * Obtain the previous parameter to a function.
1907 *
1908 * This is the opposite of LLVMGetNextParam().
1909 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001910LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001911
1912/**
1913 * Add an attribute to a function argument.
1914 *
1915 * @see llvm::Argument::addAttr()
1916 */
Devang Patel4c758ea2008-09-25 21:00:45 +00001917void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001918
1919/**
1920 * Remove an attribute from a function argument.
1921 *
1922 * @see llvm::Argument::removeAttr()
1923 */
Devang Patel4c758ea2008-09-25 21:00:45 +00001924void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001925
1926/**
1927 * Get an attribute from a function argument.
1928 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001929LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001930
1931/**
1932 * Set the alignment for a function parameter.
1933 *
1934 * @see llvm::Argument::addAttr()
Bill Wendling50d27842012-10-15 20:35:56 +00001935 * @see llvm::AttrBuilder::addAlignmentAttr()
Gregory Szorc34c863a2012-03-21 03:54:29 +00001936 */
Gordon Henriksen2d9cc212008-04-28 17:37:06 +00001937void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +00001938
Gregory Szorc34c863a2012-03-21 03:54:29 +00001939/**
1940 * @}
1941 */
1942
1943/**
1944 * @}
1945 */
1946
1947/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001948 * @}
1949 */
1950
1951/**
1952 * @}
1953 */
1954
1955/**
1956 * @defgroup LLVMCCoreValueMetadata Metadata
1957 *
1958 * @{
1959 */
1960
1961/**
1962 * Obtain a MDString value from a context.
1963 *
1964 * The returned instance corresponds to the llvm::MDString class.
1965 *
1966 * The instance is specified by string data of a specified length. The
1967 * string content is copied, so the backing memory can be freed after
1968 * this function returns.
1969 */
1970LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
1971 unsigned SLen);
1972
1973/**
1974 * Obtain a MDString value from the global context.
1975 */
1976LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
1977
1978/**
1979 * Obtain a MDNode value from a context.
1980 *
1981 * The returned value corresponds to the llvm::MDNode class.
1982 */
1983LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
1984 unsigned Count);
1985
1986/**
1987 * Obtain a MDNode value from the global context.
1988 */
1989LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
1990
1991/**
1992 * Obtain the underlying string from a MDString value.
1993 *
1994 * @param V Instance to obtain string from.
1995 * @param Len Memory address which will hold length of returned string.
1996 * @return String data in MDString.
1997 */
1998const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
1999
2000/**
Duncan Sands12ccbe72012-09-19 20:29:39 +00002001 * Obtain the number of operands from an MDNode value.
2002 *
2003 * @param V MDNode to get number of operands from.
2004 * @return Number of operands of the MDNode.
2005 */
2006unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
2007
2008/**
2009 * Obtain the given MDNode's operands.
2010 *
2011 * The passed LLVMValueRef pointer should point to enough memory to hold all of
2012 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
2013 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
2014 * MDNode's operands.
2015 *
2016 * @param V MDNode to get the operands from.
2017 * @param Dest Destination array for operands.
2018 */
2019void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
2020
2021/**
Gregory Szorc52d26602012-03-21 07:28:27 +00002022 * @}
2023 */
2024
2025/**
Gregory Szorc34c863a2012-03-21 03:54:29 +00002026 * @defgroup LLVMCCoreValueBasicBlock Basic Block
2027 *
2028 * A basic block represents a single entry single exit section of code.
2029 * Basic blocks contain a list of instructions which form the body of
2030 * the block.
2031 *
2032 * Basic blocks belong to functions. They have the type of label.
2033 *
2034 * Basic blocks are themselves values. However, the C API models them as
2035 * LLVMBasicBlockRef.
2036 *
2037 * @see llvm::BasicBlock
2038 *
2039 * @{
2040 */
2041
2042/**
2043 * Convert a basic block instance to a value type.
2044 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00002045LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002046
2047/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002048 * Determine whether an LLVMValueRef is itself a basic block.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002049 */
Chris Lattner25963c62010-01-09 22:27:07 +00002050LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002051
2052/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002053 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002054 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002055LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002056
2057/**
2058 * Obtain the function to which a basic block belongs.
2059 *
2060 * @see llvm::BasicBlock::getParent()
2061 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00002062LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002063
2064/**
2065 * Obtain the terminator instruction for a basic block.
2066 *
2067 * If the basic block does not have a terminator (it is not well-formed
2068 * if it doesn't), then NULL is returned.
2069 *
2070 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2071 *
2072 * @see llvm::BasicBlock::getTerminator()
2073 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002074LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002075
2076/**
2077 * Obtain the number of basic blocks in a function.
2078 *
2079 * @param Fn Function value to operate on.
2080 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002081unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002082
2083/**
2084 * Obtain all of the basic blocks in a function.
2085 *
2086 * This operates on a function value. The BasicBlocks parameter is a
2087 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2088 * LLVMCountBasicBlocks() in length. This array is populated with
2089 * LLVMBasicBlockRef instances.
2090 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002091void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002092
2093/**
2094 * Obtain the first basic block in a function.
2095 *
2096 * The returned basic block can be used as an iterator. You will likely
2097 * eventually call into LLVMGetNextBasicBlock() with it.
2098 *
2099 * @see llvm::Function::begin()
2100 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002101LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002102
2103/**
2104 * Obtain the last basic block in a function.
2105 *
2106 * @see llvm::Function::end()
2107 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002108LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002109
2110/**
2111 * Advance a basic block iterator.
2112 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002113LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002114
2115/**
2116 * Go backwards in a basic block iterator.
2117 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002118LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002119
2120/**
2121 * Obtain the basic block that corresponds to the entry point of a
2122 * function.
2123 *
2124 * @see llvm::Function::getEntryBlock()
2125 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002126LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002127
Gregory Szorc34c863a2012-03-21 03:54:29 +00002128/**
2129 * Append a basic block to the end of a function.
2130 *
2131 * @see llvm::BasicBlock::Create()
2132 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002133LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2134 LLVMValueRef Fn,
2135 const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002136
2137/**
2138 * Append a basic block to the end of a function using the global
2139 * context.
2140 *
2141 * @see llvm::BasicBlock::Create()
2142 */
2143LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2144
2145/**
2146 * Insert a basic block in a function before another basic block.
2147 *
2148 * The function to add to is determined by the function of the
2149 * passed basic block.
2150 *
2151 * @see llvm::BasicBlock::Create()
2152 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002153LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2154 LLVMBasicBlockRef BB,
2155 const char *Name);
2156
Gregory Szorc34c863a2012-03-21 03:54:29 +00002157/**
2158 * Insert a basic block in a function using the global context.
2159 *
2160 * @see llvm::BasicBlock::Create()
2161 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002162LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2163 const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002164
2165/**
2166 * Remove a basic block from a function and delete it.
2167 *
2168 * This deletes the basic block from its containing function and deletes
2169 * the basic block itself.
2170 *
2171 * @see llvm::BasicBlock::eraseFromParent()
2172 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002173void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002174
2175/**
2176 * Remove a basic block from a function.
2177 *
2178 * This deletes the basic block from its containing function but keep
2179 * the basic block alive.
2180 *
2181 * @see llvm::BasicBlock::removeFromParent()
2182 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002183void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002184
Gregory Szorc34c863a2012-03-21 03:54:29 +00002185/**
2186 * Move a basic block to before another one.
2187 *
2188 * @see llvm::BasicBlock::moveBefore()
2189 */
Duncan Sandsb1d61aa2010-07-19 15:31:07 +00002190void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002191
2192/**
2193 * Move a basic block to after another one.
2194 *
2195 * @see llvm::BasicBlock::moveAfter()
2196 */
Duncan Sandsb1d61aa2010-07-19 15:31:07 +00002197void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2198
Gregory Szorc34c863a2012-03-21 03:54:29 +00002199/**
2200 * Obtain the first instruction in a basic block.
2201 *
2202 * The returned LLVMValueRef corresponds to a llvm::Instruction
2203 * instance.
2204 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002205LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002206
2207/**
2208 * Obtain the last instruction in a basic block.
2209 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002210 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002211 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002212LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
Nate Begeman43c322b2011-08-23 20:27:46 +00002213
Gregory Szorc34c863a2012-03-21 03:54:29 +00002214/**
2215 * @}
2216 */
2217
2218/**
2219 * @defgroup LLVMCCoreValueInstruction Instructions
2220 *
2221 * Functions in this group relate to the inspection and manipulation of
2222 * individual instructions.
2223 *
2224 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2225 * class has a large number of descendents. llvm::Instruction is a
2226 * llvm::Value and in the C API, instructions are modeled by
2227 * LLVMValueRef.
2228 *
2229 * This group also contains sub-groups which operate on specific
2230 * llvm::Instruction types, e.g. llvm::CallInst.
2231 *
2232 * @{
2233 */
2234
2235/**
2236 * Determine whether an instruction has any metadata attached.
2237 */
2238int LLVMHasMetadata(LLVMValueRef Val);
2239
2240/**
2241 * Return metadata associated with an instruction value.
2242 */
2243LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2244
2245/**
2246 * Set metadata associated with an instruction value.
2247 */
2248void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2249
2250/**
2251 * Obtain the basic block to which an instruction belongs.
2252 *
2253 * @see llvm::Instruction::getParent()
2254 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002255LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002256
2257/**
2258 * Obtain the instruction that occurs after the one specified.
2259 *
2260 * The next instruction will be from the same basic block.
2261 *
2262 * If this is the last instruction in a basic block, NULL will be
2263 * returned.
2264 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002265LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002266
2267/**
Benjamin Kramerbde91762012-06-02 10:20:22 +00002268 * Obtain the instruction that occurred before this one.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002269 *
2270 * If the instruction is the first instruction in a basic block, NULL
2271 * will be returned.
2272 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002273LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002274
2275/**
2276 * Remove and delete an instruction.
2277 *
2278 * The instruction specified is removed from its containing building
2279 * block and then deleted.
2280 *
2281 * @see llvm::Instruction::eraseFromParent()
2282 */
Devang Pateldbebc6f2011-10-03 20:59:18 +00002283void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002284
2285/**
2286 * Obtain the code opcode for an individual instruction.
2287 *
2288 * @see llvm::Instruction::getOpCode()
2289 */
Torok Edwinab6158e2011-10-14 20:37:49 +00002290LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002291
2292/**
2293 * Obtain the predicate of an instruction.
2294 *
2295 * This is only valid for instructions that correspond to llvm::ICmpInst
2296 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2297 *
2298 * @see llvm::ICmpInst::getPredicate()
2299 */
Torok Edwin60c40de2011-10-06 12:13:20 +00002300LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +00002301
Gregory Szorc34c863a2012-03-21 03:54:29 +00002302/**
2303 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2304 *
2305 * Functions in this group apply to instructions that refer to call
2306 * sites and invocations. These correspond to C++ types in the
2307 * llvm::CallInst class tree.
2308 *
2309 * @{
2310 */
2311
2312/**
2313 * Set the calling convention for a call instruction.
2314 *
2315 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2316 * llvm::InvokeInst.
2317 *
2318 * @see llvm::CallInst::setCallingConv()
2319 * @see llvm::InvokeInst::setCallingConv()
2320 */
Gordon Henriksen1158c532007-12-29 20:45:00 +00002321void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002322
2323/**
2324 * Obtain the calling convention for a call instruction.
2325 *
2326 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2327 * usage.
2328 *
2329 * @see LLVMSetInstructionCallConv()
2330 */
Gordon Henriksen1158c532007-12-29 20:45:00 +00002331unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002332
2333
Devang Patel4c758ea2008-09-25 21:00:45 +00002334void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002335void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
Devang Patel4c758ea2008-09-25 21:00:45 +00002336 LLVMAttribute);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002337void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
Gordon Henriksen2d9cc212008-04-28 17:37:06 +00002338 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +00002339
Gregory Szorc34c863a2012-03-21 03:54:29 +00002340/**
2341 * Obtain whether a call instruction is a tail call.
2342 *
2343 * This only works on llvm::CallInst instructions.
2344 *
2345 * @see llvm::CallInst::isTailCall()
2346 */
Chris Lattner25963c62010-01-09 22:27:07 +00002347LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002348
2349/**
2350 * Set whether a call instruction is a tail call.
2351 *
2352 * This only works on llvm::CallInst instructions.
2353 *
2354 * @see llvm::CallInst::setTailCall()
2355 */
Chris Lattner25963c62010-01-09 22:27:07 +00002356void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +00002357
Gregory Szorc34c863a2012-03-21 03:54:29 +00002358/**
2359 * @}
2360 */
2361
2362/**
2363 * Obtain the default destination basic block of a switch instruction.
2364 *
2365 * This only works on llvm::SwitchInst instructions.
2366 *
2367 * @see llvm::SwitchInst::getDefaultDest()
2368 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002369LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2370
Gregory Szorc34c863a2012-03-21 03:54:29 +00002371/**
2372 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2373 *
2374 * Functions in this group only apply to instructions that map to
2375 * llvm::PHINode instances.
2376 *
2377 * @{
2378 */
2379
2380/**
2381 * Add an incoming value to the end of a PHI list.
2382 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002383void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2384 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002385
2386/**
2387 * Obtain the number of incoming basic blocks to a PHI node.
2388 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002389unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002390
2391/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002392 * Obtain an incoming value to a PHI node as an LLVMValueRef.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002393 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002394LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002395
2396/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002397 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002398 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002399LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002400
Gregory Szorc34c863a2012-03-21 03:54:29 +00002401/**
2402 * @}
2403 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002404
Gregory Szorc34c863a2012-03-21 03:54:29 +00002405/**
2406 * @}
2407 */
2408
2409/**
2410 * @}
2411 */
2412
2413/**
2414 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2415 *
2416 * An instruction builder represents a point within a basic block and is
2417 * the exclusive means of building instructions using the C interface.
2418 *
2419 * @{
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002420 */
2421
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002422LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +00002423LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +00002424void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2425 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002426void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2427void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +00002428LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +00002429void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2430void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +00002431void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2432 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002433void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2434
Erick Tryzelaard8531fa2010-02-28 09:45:59 +00002435/* Metadata */
2436void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2437LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2438void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2439
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002440/* Terminators */
2441LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2442LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +00002443LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002444 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002445LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2446LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2447 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2448LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2449 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +00002450LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2451 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002452LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2453 LLVMValueRef *Args, unsigned NumArgs,
2454 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2455 const char *Name);
Benjamin Kramer5a6568832011-08-19 01:36:54 +00002456LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2457 LLVMValueRef PersFn, unsigned NumClauses,
2458 const char *Name);
Bill Wendlingf891bf82011-07-31 06:30:59 +00002459LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002460LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2461
Gordon Henriksen097102c2008-01-01 05:50:53 +00002462/* Add a case to the switch instruction */
2463void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2464 LLVMBasicBlockRef Dest);
2465
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +00002466/* Add a destination to the indirectbr instruction */
2467void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2468
Bill Wendlingfae14752011-08-12 20:24:12 +00002469/* Add a catch or filter clause to the landingpad instruction */
2470void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2471
2472/* Set the 'cleanup' flag in the landingpad instruction */
2473void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2474
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002475/* Arithmetic */
2476LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2477 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002478LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2479 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002480LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2481 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002482LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2483 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002484LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2485 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002486LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2487 const char *Name);
2488LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2489 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002490LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2491 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002492LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2493 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002494LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2495 const char *Name);
2496LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2497 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002498LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2499 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002500LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2501 const char *Name);
2502LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2503 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002504LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2505 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002506LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2507 const char *Name);
2508LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2509 const char *Name);
2510LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2511 const char *Name);
2512LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2513 const char *Name);
2514LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2515 const char *Name);
2516LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2517 const char *Name);
2518LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2519 const char *Name);
2520LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2521 const char *Name);
2522LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2523 const char *Name);
2524LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2525 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +00002526LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2527 LLVMValueRef LHS, LLVMValueRef RHS,
2528 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002529LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002530LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2531 const char *Name);
2532LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2533 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +00002534LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002535LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2536
2537/* Memory */
2538LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2539LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2540 LLVMValueRef Val, const char *Name);
2541LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2542LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2543 LLVMValueRef Val, const char *Name);
2544LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2545LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2546 const char *Name);
2547LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2548LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2549 LLVMValueRef *Indices, unsigned NumIndices,
2550 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002551LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2552 LLVMValueRef *Indices, unsigned NumIndices,
2553 const char *Name);
2554LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2555 unsigned Idx, const char *Name);
2556LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2557 const char *Name);
2558LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2559 const char *Name);
Chris Lattner2cc6f9d2012-03-22 03:54:15 +00002560LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2561void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002562
2563/* Casts */
2564LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2565 LLVMTypeRef DestTy, const char *Name);
2566LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2567 LLVMTypeRef DestTy, const char *Name);
2568LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2569 LLVMTypeRef DestTy, const char *Name);
2570LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2571 LLVMTypeRef DestTy, const char *Name);
2572LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2573 LLVMTypeRef DestTy, const char *Name);
2574LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2575 LLVMTypeRef DestTy, const char *Name);
2576LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2577 LLVMTypeRef DestTy, const char *Name);
2578LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2579 LLVMTypeRef DestTy, const char *Name);
2580LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2581 LLVMTypeRef DestTy, const char *Name);
2582LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2583 LLVMTypeRef DestTy, const char *Name);
2584LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2585 LLVMTypeRef DestTy, const char *Name);
2586LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2587 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002588LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2589 LLVMTypeRef DestTy, const char *Name);
2590LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2591 LLVMTypeRef DestTy, const char *Name);
2592LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2593 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +00002594LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2595 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002596LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2597 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +00002598LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002599 LLVMTypeRef DestTy, const char *Name);
2600LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2601 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002602
2603/* Comparisons */
2604LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2605 LLVMValueRef LHS, LLVMValueRef RHS,
2606 const char *Name);
2607LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2608 LLVMValueRef LHS, LLVMValueRef RHS,
2609 const char *Name);
2610
2611/* Miscellaneous instructions */
2612LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2613LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2614 LLVMValueRef *Args, unsigned NumArgs,
2615 const char *Name);
2616LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2617 LLVMValueRef Then, LLVMValueRef Else,
2618 const char *Name);
2619LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2620 const char *Name);
2621LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2622 LLVMValueRef Index, const char *Name);
2623LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2624 LLVMValueRef EltVal, LLVMValueRef Index,
2625 const char *Name);
2626LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2627 LLVMValueRef V2, LLVMValueRef Mask,
2628 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +00002629LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2630 unsigned Index, const char *Name);
2631LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2632 LLVMValueRef EltVal, unsigned Index,
2633 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +00002634
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002635LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2636 const char *Name);
2637LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2638 const char *Name);
2639LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2640 LLVMValueRef RHS, const char *Name);
NAKAMURA Takumia3a81352013-10-23 17:56:29 +00002641LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B,LLVMAtomicRMWBinOp op,
2642 LLVMValueRef PTR, LLVMValueRef Val,
2643 LLVMAtomicOrdering ordering,
Carlo Kok8c6719b2013-04-23 13:21:19 +00002644 LLVMBool singleThread);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002645
Gregory Szorc34c863a2012-03-21 03:54:29 +00002646/**
2647 * @}
2648 */
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002649
Gregory Szorc34c863a2012-03-21 03:54:29 +00002650/**
2651 * @defgroup LLVMCCoreModuleProvider Module Providers
2652 *
2653 * @{
2654 */
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002655
Gregory Szorc34c863a2012-03-21 03:54:29 +00002656/**
2657 * Changes the type of M so it can be passed to FunctionPassManagers and the
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002658 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002659 */
2660LLVMModuleProviderRef
2661LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2662
Gregory Szorc34c863a2012-03-21 03:54:29 +00002663/**
2664 * Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002665 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002666void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002667
Gregory Szorc34c863a2012-03-21 03:54:29 +00002668/**
2669 * @}
2670 */
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002671
Gregory Szorc34c863a2012-03-21 03:54:29 +00002672/**
2673 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2674 *
2675 * @{
2676 */
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002677
Chris Lattner25963c62010-01-09 22:27:07 +00002678LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2679 LLVMMemoryBufferRef *OutMemBuf,
2680 char **OutMessage);
2681LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2682 char **OutMessage);
Bill Wendling526276a2013-02-14 19:11:28 +00002683LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2684 size_t InputDataLength,
2685 const char *BufferName,
Bill Wendlingc9baa962013-02-14 19:39:14 +00002686 LLVMBool RequiresNullTerminator);
Bill Wendling526276a2013-02-14 19:11:28 +00002687LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2688 size_t InputDataLength,
2689 const char *BufferName);
Tom Stellard62c03202013-04-18 19:50:53 +00002690const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
Tom Stellardb7fb7242013-04-16 23:12:51 +00002691size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002692void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2693
Gregory Szorc34c863a2012-03-21 03:54:29 +00002694/**
2695 * @}
2696 */
2697
2698/**
2699 * @defgroup LLVMCCorePassRegistry Pass Registry
2700 *
2701 * @{
2702 */
Owen Anderson4698c5d2010-10-07 17:55:47 +00002703
2704/** Return the global pass registry, for use with initialization functions.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002705 @see llvm::PassRegistry::getPassRegistry */
Owen Anderson4698c5d2010-10-07 17:55:47 +00002706LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002707
Gregory Szorc34c863a2012-03-21 03:54:29 +00002708/**
2709 * @}
2710 */
2711
2712/**
2713 * @defgroup LLVMCCorePassManagers Pass Managers
2714 *
2715 * @{
2716 */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002717
2718/** Constructs a new whole-module pass pipeline. This type of pipeline is
2719 suitable for link-time optimization and whole-module transformations.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002720 @see llvm::PassManager::PassManager */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00002721LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002722
2723/** Constructs a new function-by-function pass pipeline over the module
2724 provider. It does not take ownership of the module provider. This type of
2725 pipeline is suitable for code generation and JIT compilation tasks.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002726 @see llvm::FunctionPassManager::FunctionPassManager */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00002727LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2728
2729/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002730LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2731
2732/** Initializes, executes on the provided module, and finalizes all of the
2733 passes scheduled in the pass manager. Returns 1 if any of the passes
Gregory Szorc34c863a2012-03-21 03:54:29 +00002734 modified the module, 0 otherwise.
2735 @see llvm::PassManager::run(Module&) */
Chris Lattner25963c62010-01-09 22:27:07 +00002736LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002737
2738/** Initializes all of the function passes scheduled in the function pass
2739 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002740 @see llvm::FunctionPassManager::doInitialization */
Chris Lattner25963c62010-01-09 22:27:07 +00002741LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002742
2743/** Executes all of the function passes scheduled in the function pass manager
2744 on the provided function. Returns 1 if any of the passes modified the
2745 function, false otherwise.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002746 @see llvm::FunctionPassManager::run(Function&) */
Chris Lattner25963c62010-01-09 22:27:07 +00002747LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002748
2749/** Finalizes all of the function passes scheduled in in the function pass
2750 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002751 @see llvm::FunctionPassManager::doFinalization */
Chris Lattner25963c62010-01-09 22:27:07 +00002752LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002753
2754/** Frees the memory of a pass pipeline. For function pipelines, does not free
2755 the module provider.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002756 @see llvm::PassManagerBase::~PassManagerBase. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002757void LLVMDisposePassManager(LLVMPassManagerRef PM);
2758
Gregory Szorc34c863a2012-03-21 03:54:29 +00002759/**
2760 * @}
2761 */
2762
2763/**
Duncan Sands1cba0a82013-02-17 16:35:51 +00002764 * @defgroup LLVMCCoreThreading Threading
2765 *
2766 * Handle the structures needed to make LLVM safe for multithreading.
2767 *
2768 * @{
2769 */
2770
2771/** Allocate and initialize structures needed to make LLVM safe for
2772 multithreading. The return value indicates whether multithreaded
2773 initialization succeeded. Must be executed in isolation from all
2774 other LLVM api calls.
2775 @see llvm::llvm_start_multithreaded */
Benjamin Kramer325ec892013-10-23 16:57:34 +00002776LLVMBool LLVMStartMultithreaded(void);
Duncan Sands1cba0a82013-02-17 16:35:51 +00002777
2778/** Deallocate structures necessary to make LLVM safe for multithreading.
2779 Must be executed in isolation from all other LLVM api calls.
2780 @see llvm::llvm_stop_multithreaded */
Benjamin Kramer325ec892013-10-23 16:57:34 +00002781void LLVMStopMultithreaded(void);
Duncan Sands1cba0a82013-02-17 16:35:51 +00002782
2783/** Check whether LLVM is executing in thread-safe mode or not.
2784 @see llvm::llvm_is_multithreaded */
Benjamin Kramer325ec892013-10-23 16:57:34 +00002785LLVMBool LLVMIsMultithreaded(void);
Duncan Sands1cba0a82013-02-17 16:35:51 +00002786
2787/**
2788 * @}
2789 */
2790
2791/**
Gregory Szorc34c863a2012-03-21 03:54:29 +00002792 * @}
2793 */
2794
2795/**
2796 * @}
2797 */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002798
Gordon Henriksen76a03742007-09-18 03:18:57 +00002799#ifdef __cplusplus
2800}
Evan Cheng2e254d02013-04-04 17:40:53 +00002801#endif /* !defined(__cplusplus) */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00002802
Evan Cheng2e254d02013-04-04 17:40:53 +00002803#endif /* !defined(LLVM_C_CORE_H) */