blob: caadab1bac2c24c643522fdf182e8331a3ff9226 [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. */
Bill Wendling34bc34e2012-08-17 18:33:14 +0000277 LLVMLinkOnceODRAutoHideLinkage, /**< Like LinkOnceODR, but possibly hidden. */
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. */
357 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the
358 operations affecting a specific address,
359 a consistent ordering exists */
360 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort
361 necessary to acquire a lock to access other
362 memory with normal loads and stores. */
363 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with
364 a barrier of the sort necessary to release
365 a lock. */
366 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
367 Release barrier (for fences and
368 operations which both read and write
369 memory). */
370 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
377 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
389 original using a signed comparison and return
390 the old one */
391 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
392 original using a signed comparison and return
393 the old one */
394 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
395 original using an unsigned comparison and return
396 the old one */
397 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
398 original using an unsigned comparison and return
399 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 */
411void LLVMShutdown();
412
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
419
Gregory Szorc34c863a2012-03-21 03:54:29 +0000420/**
421 * @defgroup LLVMCCoreContext Contexts
422 *
423 * Contexts are execution states for the core LLVM IR system.
424 *
425 * Most types are tied to a context instance. Multiple contexts can
426 * exist simultaneously. A single context is not thread safe. However,
427 * different contexts can execute on different threads simultaneously.
428 *
429 * @{
430 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000431
Gregory Szorc34c863a2012-03-21 03:54:29 +0000432/**
433 * Create a new context.
434 *
435 * Every call to this function should be paired with a call to
436 * LLVMContextDispose() or the context will leak memory.
437 */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000438LLVMContextRef LLVMContextCreate(void);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000439
440/**
441 * Obtain the global context instance.
442 */
Erick Tryzelaarf34cb0c2009-08-30 23:38:06 +0000443LLVMContextRef LLVMGetGlobalContext(void);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000444
445/**
446 * Destroy a context instance.
447 *
448 * This should be called for every call to LLVMContextCreate() or memory
449 * will be leaked.
450 */
Owen Anderson6773d382009-07-01 16:58:40 +0000451void LLVMContextDispose(LLVMContextRef C);
452
Erick Tryzelaard8531fa2010-02-28 09:45:59 +0000453unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
454 unsigned SLen);
455unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
456
Gregory Szorc34c863a2012-03-21 03:54:29 +0000457/**
458 * @}
459 */
460
Gregory Szorc52d26602012-03-21 07:28:27 +0000461/**
462 * @defgroup LLVMCCoreModule Modules
Gregory Szorc34c863a2012-03-21 03:54:29 +0000463 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +0000464 * Modules represent the top-level structure in an LLVM program. An LLVM
Gregory Szorc34c863a2012-03-21 03:54:29 +0000465 * module is effectively a translation unit or a collection of
466 * translation units merged together.
467 *
468 * @{
469 */
470
Gregory Szorc34c863a2012-03-21 03:54:29 +0000471/**
472 * Create a new, empty module in the global context.
473 *
474 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
475 * LLVMGetGlobalContext() as the context parameter.
476 *
477 * Every invocation should be paired with LLVMDisposeModule() or memory
478 * will be leaked.
479 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000480LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000481
482/**
483 * Create a new, empty module in a specific context.
484 *
485 * Every invocation should be paired with LLVMDisposeModule() or memory
486 * will be leaked.
487 */
Owen Anderson31d44e42009-07-02 07:17:57 +0000488LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
489 LLVMContextRef C);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000490
Gregory Szorc34c863a2012-03-21 03:54:29 +0000491/**
492 * Destroy a module instance.
493 *
494 * This must be called for every created module or memory will be
495 * leaked.
496 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000497void LLVMDisposeModule(LLVMModuleRef M);
498
Gregory Szorc34c863a2012-03-21 03:54:29 +0000499/**
500 * Obtain the data layout for a module.
501 *
502 * @see Module::getDataLayout()
503 */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000504const char *LLVMGetDataLayout(LLVMModuleRef M);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000505
506/**
507 * Set the data layout for a module.
508 *
509 * @see Module::setDataLayout()
510 */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000511void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
512
Gregory Szorc34c863a2012-03-21 03:54:29 +0000513/**
514 * Obtain the target triple for a module.
515 *
516 * @see Module::getTargetTriple()
517 */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000518const char *LLVMGetTarget(LLVMModuleRef M);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000519
520/**
521 * Set the target triple for a module.
522 *
523 * @see Module::setTargetTriple()
524 */
Gordon Henriksen05568bb2007-12-27 20:13:47 +0000525void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
526
Gregory Szorc34c863a2012-03-21 03:54:29 +0000527/**
528 * Dump a representation of a module to stderr.
529 *
530 * @see Module::dump()
531 */
Gordon Henriksen6c6075e2008-03-14 23:58:56 +0000532void LLVMDumpModule(LLVMModuleRef M);
533
Gregory Szorc34c863a2012-03-21 03:54:29 +0000534/**
Hans Wennborgb7ef2fe2012-05-09 16:54:17 +0000535 * Print a representation of a module to a file. The ErrorMessage needs to be
536 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
537 *
538 * @see Module::print()
539 */
540LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
541 char **ErrorMessage);
542
543/**
Anders Waldenborg84355db2013-10-16 18:00:54 +0000544 * Return a string representation of the module. Use
545 * LLVMDisposeMessage to free the string.
546 *
547 * @see Module::print()
548 */
549char *LLVMPrintModuleToString(LLVMModuleRef M);
550
551/**
Gregory Szorc34c863a2012-03-21 03:54:29 +0000552 * Set inline assembly for a module.
553 *
554 * @see Module::setModuleInlineAsm()
555 */
Chris Lattner26941452010-04-10 17:52:58 +0000556void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000557
Gregory Szorc34c863a2012-03-21 03:54:29 +0000558/**
559 * Obtain the context to which this module is associated.
560 *
561 * @see Module::getContext()
562 */
Chris Lattnera7e04b02010-11-28 20:03:44 +0000563LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
564
Gregory Szorc34c863a2012-03-21 03:54:29 +0000565/**
566 * Obtain a Type from a module by its registered name.
567 */
568LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000569
Gregory Szorc34c863a2012-03-21 03:54:29 +0000570/**
571 * Obtain the number of operands for named metadata in a module.
572 *
573 * @see llvm::Module::getNamedMetadata()
574 */
575unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
576
577/**
578 * Obtain the named metadata operands for a module.
579 *
580 * The passed LLVMValueRef pointer should refer to an array of
581 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
582 * array will be populated with the LLVMValueRef instances. Each
583 * instance corresponds to a llvm::MDNode.
584 *
585 * @see llvm::Module::getNamedMetadata()
586 * @see llvm::MDNode::getOperand()
587 */
588void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
589
590/**
591 * Add an operand to named metadata.
592 *
593 * @see llvm::Module::getNamedMetadata()
594 * @see llvm::MDNode::addOperand()
595 */
596void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
597 LLVMValueRef Val);
598
Gregory Szorc52d26602012-03-21 07:28:27 +0000599/**
600 * Add a function to a module under a specified name.
601 *
602 * @see llvm::Function::Create()
603 */
604LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
605 LLVMTypeRef FunctionTy);
606
607/**
608 * Obtain a Function value from a Module by its name.
609 *
610 * The returned value corresponds to a llvm::Function value.
611 *
612 * @see llvm::Module::getFunction()
613 */
614LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
615
616/**
617 * Obtain an iterator to the first Function in a Module.
618 *
619 * @see llvm::Module::begin()
620 */
621LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
622
623/**
624 * Obtain an iterator to the last Function in a Module.
625 *
626 * @see llvm::Module::end()
627 */
628LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
629
630/**
631 * Advance a Function iterator to the next Function.
632 *
633 * Returns NULL if the iterator was already at the end and there are no more
634 * functions.
635 */
636LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
637
638/**
639 * Decrement a Function iterator to the previous Function.
640 *
641 * Returns NULL if the iterator was already at the beginning and there are
642 * no previous functions.
643 */
644LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000645
646/**
647 * @}
648 */
649
650/**
651 * @defgroup LLVMCCoreType Types
652 *
653 * Types represent the type of a value.
654 *
655 * Types are associated with a context instance. The context internally
656 * deduplicates types so there is only 1 instance of a specific type
657 * alive at a time. In other words, a unique type is shared among all
658 * consumers within a context.
659 *
660 * A Type in the C API corresponds to llvm::Type.
661 *
662 * Types have the following hierarchy:
663 *
Gordon Henriksen76a03742007-09-18 03:18:57 +0000664 * types:
665 * integer type
666 * real type
667 * function type
668 * sequence types:
669 * array type
670 * pointer type
671 * vector type
672 * void type
673 * label type
674 * opaque type
Gregory Szorc34c863a2012-03-21 03:54:29 +0000675 *
676 * @{
Gordon Henriksen76a03742007-09-18 03:18:57 +0000677 */
678
Gregory Szorc34c863a2012-03-21 03:54:29 +0000679/**
680 * Obtain the enumerated type of a Type instance.
681 *
682 * @see llvm::Type:getTypeID()
683 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000684LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000685
686/**
687 * Whether the type has a known size.
688 *
689 * Things that don't have a size are abstract types, labels, and void.a
690 *
691 * @see llvm::Type::isSized()
692 */
Torok Edwin1cd9ade2011-10-06 12:13:28 +0000693LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
Gordon Henriksena49d4352008-03-07 19:13:06 +0000694
Gregory Szorc34c863a2012-03-21 03:54:29 +0000695/**
696 * Obtain the context to which this type instance is associated.
697 *
698 * @see llvm::Type::getContext()
699 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000700LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
701
Gregory Szorc34c863a2012-03-21 03:54:29 +0000702/**
703 * @defgroup LLVMCCoreTypeInt Integer Types
704 *
705 * Functions in this section operate on integer types.
706 *
707 * @{
708 */
709
710/**
711 * Obtain an integer type from a context with specified bit width.
712 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000713LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
714LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
715LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
716LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
717LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
718LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
719
Gregory Szorc34c863a2012-03-21 03:54:29 +0000720/**
721 * Obtain an integer type from the global context with a specified bit
722 * width.
723 */
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000724LLVMTypeRef LLVMInt1Type(void);
725LLVMTypeRef LLVMInt8Type(void);
726LLVMTypeRef LLVMInt16Type(void);
727LLVMTypeRef LLVMInt32Type(void);
728LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000729LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000730unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000731
Gregory Szorc34c863a2012-03-21 03:54:29 +0000732/**
733 * @}
734 */
735
736/**
737 * @defgroup LLVMCCoreTypeFloat Floating Point Types
738 *
739 * @{
740 */
741
742/**
743 * Obtain a 16-bit floating point type from a context.
744 */
Dan Gohman518cda42011-12-17 00:04:22 +0000745LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000746
747/**
748 * Obtain a 32-bit floating point type from a context.
749 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000750LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000751
752/**
753 * Obtain a 64-bit floating point type from a context.
754 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000755LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000756
757/**
758 * Obtain a 80-bit floating point type (X87) from a context.
759 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000760LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000761
762/**
763 * Obtain a 128-bit floating point type (112-bit mantissa) from a
764 * context.
765 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000766LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000767
768/**
769 * Obtain a 128-bit floating point type (two 64-bits) from a context.
770 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000771LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
772
Gregory Szorc34c863a2012-03-21 03:54:29 +0000773/**
774 * Obtain a floating point type from the global context.
775 *
776 * These map to the functions in this group of the same name.
777 */
Dan Gohman518cda42011-12-17 00:04:22 +0000778LLVMTypeRef LLVMHalfType(void);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000779LLVMTypeRef LLVMFloatType(void);
780LLVMTypeRef LLVMDoubleType(void);
781LLVMTypeRef LLVMX86FP80Type(void);
782LLVMTypeRef LLVMFP128Type(void);
783LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000784
Gregory Szorc34c863a2012-03-21 03:54:29 +0000785/**
786 * @}
787 */
788
789/**
790 * @defgroup LLVMCCoreTypeFunction Function Types
791 *
792 * @{
793 */
794
795/**
796 * Obtain a function type consisting of a specified signature.
797 *
798 * The function is defined as a tuple of a return Type, a list of
799 * parameter types, and whether the function is variadic.
800 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000801LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
802 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000803 LLVMBool IsVarArg);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000804
805/**
806 * Returns whether a function type is variadic.
807 */
Chris Lattner25963c62010-01-09 22:27:07 +0000808LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000809
810/**
811 * Obtain the Type this function Type returns.
812 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000813LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000814
815/**
816 * Obtain the number of parameters this function accepts.
817 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000818unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000819
820/**
821 * Obtain the types of a function's parameters.
822 *
823 * The Dest parameter should point to a pre-allocated array of
824 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
825 * first LLVMCountParamTypes() entries in the array will be populated
826 * with LLVMTypeRef instances.
827 *
828 * @param FunctionTy The function type to operate on.
829 * @param Dest Memory address of an array to be filled with result.
830 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000831void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000832
Gregory Szorc34c863a2012-03-21 03:54:29 +0000833/**
834 * @}
835 */
836
837/**
838 * @defgroup LLVMCCoreTypeStruct Structure Types
839 *
840 * These functions relate to LLVMTypeRef instances.
841 *
842 * @see llvm::StructType
843 *
844 * @{
845 */
846
847/**
848 * Create a new structure type in a context.
849 *
850 * A structure is specified by a list of inner elements/types and
851 * whether these can be packed together.
852 *
853 * @see llvm::StructType::create()
854 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000855LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000856 unsigned ElementCount, LLVMBool Packed);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000857
858/**
859 * Create a new structure type in the global context.
860 *
861 * @see llvm::StructType::create()
862 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000863LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000864 LLVMBool Packed);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000865
866/**
867 * Create an empty structure in a context having a specified name.
868 *
869 * @see llvm::StructType::create()
870 */
Chris Lattnere71ccde2011-07-14 05:53:17 +0000871LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000872
873/**
874 * Obtain the name of a structure.
875 *
876 * @see llvm::StructType::getName()
877 */
Torok Edwin0d5f6ae2011-10-06 12:12:50 +0000878const char *LLVMGetStructName(LLVMTypeRef Ty);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000879
880/**
881 * Set the contents of a structure type.
882 *
883 * @see llvm::StructType::setBody()
884 */
Chris Lattnere71ccde2011-07-14 05:53:17 +0000885void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
886 unsigned ElementCount, LLVMBool Packed);
887
Gregory Szorc34c863a2012-03-21 03:54:29 +0000888/**
889 * Get the number of elements defined inside the structure.
890 *
891 * @see llvm::StructType::getNumElements()
892 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000893unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000894
895/**
896 * Get the elements within a structure.
897 *
898 * The function is passed the address of a pre-allocated array of
899 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
900 * invocation, this array will be populated with the structure's
901 * elements. The objects in the destination array will have a lifetime
902 * of the structure type itself, which is the lifetime of the context it
903 * is contained in.
904 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000905void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000906
907/**
908 * Determine whether a structure is packed.
909 *
910 * @see llvm::StructType::isPacked()
911 */
Chris Lattner25963c62010-01-09 22:27:07 +0000912LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000913
914/**
915 * Determine whether a structure is opaque.
916 *
917 * @see llvm::StructType::isOpaque()
918 */
Chris Lattner17cf05b2011-07-14 16:20:28 +0000919LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
920
Gregory Szorc34c863a2012-03-21 03:54:29 +0000921/**
922 * @}
923 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000924
Gregory Szorc34c863a2012-03-21 03:54:29 +0000925
926/**
927 * @defgroup LLVMCCoreTypeSequential Sequential Types
928 *
929 * Sequential types represents "arrays" of types. This is a super class
930 * for array, vector, and pointer types.
931 *
932 * @{
933 */
934
935/**
936 * Obtain the type of elements within a sequential type.
937 *
938 * This works on array, vector, and pointer types.
939 *
940 * @see llvm::SequentialType::getElementType()
941 */
942LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
943
944/**
945 * Create a fixed size array type that refers to a specific type.
946 *
947 * The created type will exist in the context that its element type
948 * exists in.
949 *
950 * @see llvm::ArrayType::get()
951 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000952LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000953
954/**
955 * Obtain the length of an array type.
956 *
957 * This only works on types that represent arrays.
958 *
959 * @see llvm::ArrayType::getNumElements()
960 */
961unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
962
963/**
964 * Create a pointer type that points to a defined type.
965 *
966 * The created type will exist in the context that its pointee type
967 * exists in.
968 *
969 * @see llvm::PointerType::get()
970 */
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000971LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000972
973/**
974 * Obtain the address space of a pointer type.
975 *
976 * This only works on types that represent pointers.
977 *
978 * @see llvm::PointerType::getAddressSpace()
979 */
980unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
981
982/**
983 * Create a vector type that contains a defined type and has a specific
984 * number of elements.
985 *
986 * The created type will exist in the context thats its element type
987 * exists in.
988 *
989 * @see llvm::VectorType::get()
990 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000991LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000992
Gregory Szorc34c863a2012-03-21 03:54:29 +0000993/**
994 * Obtain the number of elements in a vector type.
995 *
996 * This only works on types that represent vectors.
997 *
998 * @see llvm::VectorType::getNumElements()
999 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001000unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1001
Gregory Szorc34c863a2012-03-21 03:54:29 +00001002/**
1003 * @}
1004 */
1005
1006/**
1007 * @defgroup LLVMCCoreTypeOther Other Types
1008 *
1009 * @{
1010 */
1011
1012/**
1013 * Create a void type in a context.
1014 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001015LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001016
1017/**
1018 * Create a label type in a context.
1019 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001020LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001021
1022/**
1023 * Create a X86 MMX type in a context.
1024 */
Dale Johannesen95b67af2010-09-10 21:58:02 +00001025LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001026
Gregory Szorc34c863a2012-03-21 03:54:29 +00001027/**
1028 * These are similar to the above functions except they operate on the
1029 * global context.
1030 */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001031LLVMTypeRef LLVMVoidType(void);
1032LLVMTypeRef LLVMLabelType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +00001033LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001034
Gregory Szorc34c863a2012-03-21 03:54:29 +00001035/**
1036 * @}
1037 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001038
Gregory Szorc34c863a2012-03-21 03:54:29 +00001039/**
1040 * @}
1041 */
1042
1043/**
1044 * @defgroup LLVMCCoreValues Values
1045 *
1046 * The bulk of LLVM's object model consists of values, which comprise a very
Gordon Henriksen76a03742007-09-18 03:18:57 +00001047 * rich type hierarchy.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001048 *
1049 * LLVMValueRef essentially represents llvm::Value. There is a rich
1050 * hierarchy of classes within this type. Depending on the instance
Eli Benderskyc52863c2012-08-10 18:30:44 +00001051 * obtained, not all APIs are available.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001052 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001053 * Callers can determine the type of an LLVMValueRef by calling the
Gregory Szorc34c863a2012-03-21 03:54:29 +00001054 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1055 * functions are defined by a macro, so it isn't obvious which are
1056 * available by looking at the Doxygen source code. Instead, look at the
1057 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1058 * of value names given. These value names also correspond to classes in
1059 * the llvm::Value hierarchy.
1060 *
1061 * @{
Gordon Henriksen76a03742007-09-18 03:18:57 +00001062 */
1063
Gordon Henriksen29e38942008-12-19 18:39:45 +00001064#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1065 macro(Argument) \
1066 macro(BasicBlock) \
1067 macro(InlineAsm) \
Torok Edwind09b7572011-10-14 20:37:56 +00001068 macro(MDNode) \
1069 macro(MDString) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001070 macro(User) \
1071 macro(Constant) \
Torok Edwind09b7572011-10-14 20:37:56 +00001072 macro(BlockAddress) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001073 macro(ConstantAggregateZero) \
1074 macro(ConstantArray) \
1075 macro(ConstantExpr) \
1076 macro(ConstantFP) \
1077 macro(ConstantInt) \
1078 macro(ConstantPointerNull) \
1079 macro(ConstantStruct) \
1080 macro(ConstantVector) \
1081 macro(GlobalValue) \
1082 macro(Function) \
1083 macro(GlobalAlias) \
1084 macro(GlobalVariable) \
1085 macro(UndefValue) \
1086 macro(Instruction) \
1087 macro(BinaryOperator) \
1088 macro(CallInst) \
1089 macro(IntrinsicInst) \
1090 macro(DbgInfoIntrinsic) \
1091 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001092 macro(MemIntrinsic) \
1093 macro(MemCpyInst) \
1094 macro(MemMoveInst) \
1095 macro(MemSetInst) \
1096 macro(CmpInst) \
Torok Edwind09b7572011-10-14 20:37:56 +00001097 macro(FCmpInst) \
1098 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001099 macro(ExtractElementInst) \
1100 macro(GetElementPtrInst) \
1101 macro(InsertElementInst) \
1102 macro(InsertValueInst) \
Bill Wendlingfae14752011-08-12 20:24:12 +00001103 macro(LandingPadInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001104 macro(PHINode) \
1105 macro(SelectInst) \
1106 macro(ShuffleVectorInst) \
1107 macro(StoreInst) \
1108 macro(TerminatorInst) \
1109 macro(BranchInst) \
Torok Edwind09b7572011-10-14 20:37:56 +00001110 macro(IndirectBrInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001111 macro(InvokeInst) \
1112 macro(ReturnInst) \
1113 macro(SwitchInst) \
1114 macro(UnreachableInst) \
Bill Wendlingf891bf82011-07-31 06:30:59 +00001115 macro(ResumeInst) \
Duncan Sands5e37e992013-05-06 08:55:45 +00001116 macro(UnaryInstruction) \
1117 macro(AllocaInst) \
1118 macro(CastInst) \
1119 macro(BitCastInst) \
1120 macro(FPExtInst) \
1121 macro(FPToSIInst) \
1122 macro(FPToUIInst) \
1123 macro(FPTruncInst) \
1124 macro(IntToPtrInst) \
1125 macro(PtrToIntInst) \
1126 macro(SExtInst) \
1127 macro(SIToFPInst) \
1128 macro(TruncInst) \
1129 macro(UIToFPInst) \
1130 macro(ZExtInst) \
1131 macro(ExtractValueInst) \
1132 macro(LoadInst) \
1133 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +00001134
Gregory Szorc34c863a2012-03-21 03:54:29 +00001135/**
1136 * @defgroup LLVMCCoreValueGeneral General APIs
1137 *
1138 * Functions in this section work on all LLVMValueRef instances,
1139 * regardless of their sub-type. They correspond to functions available
1140 * on llvm::Value.
1141 *
1142 * @{
1143 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001144
Gregory Szorc34c863a2012-03-21 03:54:29 +00001145/**
1146 * Obtain the type of a value.
1147 *
1148 * @see llvm::Value::getType()
1149 */
1150LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1151
1152/**
1153 * Obtain the string name of a value.
1154 *
1155 * @see llvm::Value::getName()
1156 */
1157const char *LLVMGetValueName(LLVMValueRef Val);
1158
1159/**
1160 * Set the string name of a value.
1161 *
1162 * @see llvm::Value::setName()
1163 */
1164void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1165
1166/**
1167 * Dump a representation of a value to stderr.
1168 *
1169 * @see llvm::Value::dump()
1170 */
1171void LLVMDumpValue(LLVMValueRef Val);
1172
1173/**
1174 * Replace all uses of a value with another one.
1175 *
1176 * @see llvm::Value::replaceAllUsesWith()
1177 */
1178void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1179
1180/**
1181 * Determine whether the specified constant instance is constant.
1182 */
1183LLVMBool LLVMIsConstant(LLVMValueRef Val);
1184
1185/**
1186 * Determine whether a value instance is undefined.
1187 */
1188LLVMBool LLVMIsUndef(LLVMValueRef Val);
1189
1190/**
1191 * Convert value instances between types.
1192 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001193 * Internally, an LLVMValueRef is "pinned" to a specific type. This
Gregory Szorc34c863a2012-03-21 03:54:29 +00001194 * series of functions allows you to cast an instance to a specific
1195 * type.
1196 *
1197 * If the cast is not valid for the specified type, NULL is returned.
1198 *
1199 * @see llvm::dyn_cast_or_null<>
1200 */
Gordon Henriksen29e38942008-12-19 18:39:45 +00001201#define LLVM_DECLARE_VALUE_CAST(name) \
1202 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1203LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1204
Gregory Szorc34c863a2012-03-21 03:54:29 +00001205/**
1206 * @}
1207 */
1208
1209/**
1210 * @defgroup LLVMCCoreValueUses Usage
1211 *
1212 * This module defines functions that allow you to inspect the uses of a
1213 * LLVMValueRef.
1214 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001215 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001216 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1217 * llvm::User and llvm::Value.
1218 *
1219 * @{
1220 */
1221
1222/**
1223 * Obtain the first use of a value.
1224 *
1225 * Uses are obtained in an iterator fashion. First, call this function
1226 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
Eli Benderskyc52863c2012-08-10 18:30:44 +00001227 * on that instance and all subsequently obtained instances until
Gregory Szorc34c863a2012-03-21 03:54:29 +00001228 * LLVMGetNextUse() returns NULL.
1229 *
1230 * @see llvm::Value::use_begin()
1231 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001232LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001233
1234/**
1235 * Obtain the next use of a value.
1236 *
1237 * This effectively advances the iterator. It returns NULL if you are on
1238 * the final use and no more are available.
1239 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001240LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001241
1242/**
1243 * Obtain the user value for a user.
1244 *
1245 * The returned value corresponds to a llvm::User type.
1246 *
1247 * @see llvm::Use::getUser()
1248 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001249LLVMValueRef LLVMGetUser(LLVMUseRef U);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001250
1251/**
1252 * Obtain the value this use corresponds to.
1253 *
1254 * @see llvm::Use::get().
1255 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001256LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +00001257
Gregory Szorc34c863a2012-03-21 03:54:29 +00001258/**
1259 * @}
1260 */
1261
1262/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001263 * @defgroup LLVMCCoreValueUser User value
Gregory Szorc34c863a2012-03-21 03:54:29 +00001264 *
1265 * Function in this group pertain to LLVMValueRef instances that descent
1266 * from llvm::User. This includes constants, instructions, and
1267 * operators.
1268 *
1269 * @{
1270 */
1271
1272/**
1273 * Obtain an operand at a specific index in a llvm::User value.
1274 *
1275 * @see llvm::User::getOperand()
1276 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001277LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001278
1279/**
1280 * Set an operand at a specific index in a llvm::User value.
1281 *
1282 * @see llvm::User::setOperand()
1283 */
Erick Tryzelaarb4d48702010-08-20 14:51:22 +00001284void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001285
1286/**
1287 * Obtain the number of operands in a llvm::User value.
1288 *
1289 * @see llvm::User::getNumOperands()
1290 */
Erick Tryzelaarb4d48702010-08-20 14:51:22 +00001291int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +00001292
Gregory Szorc34c863a2012-03-21 03:54:29 +00001293/**
1294 * @}
1295 */
1296
1297/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001298 * @defgroup LLVMCCoreValueConstant Constants
Gregory Szorc34c863a2012-03-21 03:54:29 +00001299 *
1300 * This section contains APIs for interacting with LLVMValueRef that
1301 * correspond to llvm::Constant instances.
1302 *
1303 * These functions will work for any LLVMValueRef in the llvm::Constant
1304 * class hierarchy.
1305 *
1306 * @{
1307 */
1308
1309/**
1310 * Obtain a constant value referring to the null instance of a type.
1311 *
1312 * @see llvm::Constant::getNullValue()
1313 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001314LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
Gregory Szorc34c863a2012-03-21 03:54:29 +00001315
1316/**
1317 * Obtain a constant value referring to the instance of a type
1318 * consisting of all ones.
1319 *
1320 * This is only valid for integer types.
1321 *
1322 * @see llvm::Constant::getAllOnesValue()
1323 */
1324LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1325
1326/**
1327 * Obtain a constant value referring to an undefined value of a type.
1328 *
1329 * @see llvm::UndefValue::get()
1330 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001331LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001332
1333/**
1334 * Determine whether a value instance is null.
1335 *
1336 * @see llvm::Constant::isNullValue()
1337 */
Chris Lattner25963c62010-01-09 22:27:07 +00001338LLVMBool LLVMIsNull(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001339
1340/**
1341 * Obtain a constant that is a constant pointer pointing to NULL for a
1342 * specified type.
1343 */
Chris Lattner7f318242009-07-06 17:29:59 +00001344LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001345
Gregory Szorc34c863a2012-03-21 03:54:29 +00001346/**
1347 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1348 *
1349 * Functions in this group model LLVMValueRef instances that correspond
1350 * to constants referring to scalar types.
1351 *
1352 * For integer types, the LLVMTypeRef parameter should correspond to a
1353 * llvm::IntegerType instance and the returned LLVMValueRef will
1354 * correspond to a llvm::ConstantInt.
1355 *
1356 * For floating point types, the LLVMTypeRef returned corresponds to a
1357 * llvm::ConstantFP.
1358 *
1359 * @{
1360 */
Erick Tryzelaard8531fa2010-02-28 09:45:59 +00001361
Gregory Szorc34c863a2012-03-21 03:54:29 +00001362/**
1363 * Obtain a constant value for an integer type.
1364 *
1365 * The returned value corresponds to a llvm::ConstantInt.
1366 *
1367 * @see llvm::ConstantInt::get()
1368 *
1369 * @param IntTy Integer type to obtain value of.
1370 * @param N The value the returned instance should refer to.
1371 * @param SignExtend Whether to sign extend the produced value.
1372 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001373LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +00001374 LLVMBool SignExtend);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001375
1376/**
1377 * Obtain a constant value for an integer of arbitrary precision.
1378 *
1379 * @see llvm::ConstantInt::get()
1380 */
Chris Lattner4329e072010-11-23 02:47:22 +00001381LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1382 unsigned NumWords,
1383 const uint64_t Words[]);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001384
1385/**
1386 * Obtain a constant value for an integer parsed from a string.
1387 *
1388 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1389 * string's length is available, it is preferred to call that function
1390 * instead.
1391 *
1392 * @see llvm::ConstantInt::get()
1393 */
Erick Tryzelaardd991352009-08-16 23:36:46 +00001394LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1395 uint8_t Radix);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001396
1397/**
1398 * Obtain a constant value for an integer parsed from a string with
1399 * specified length.
1400 *
1401 * @see llvm::ConstantInt::get()
1402 */
Erick Tryzelaardd991352009-08-16 23:36:46 +00001403LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1404 unsigned SLen, uint8_t Radix);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001405
1406/**
1407 * Obtain a constant value referring to a double floating point value.
1408 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001409LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001410
1411/**
1412 * Obtain a constant for a floating point value parsed from a string.
1413 *
1414 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1415 * should be used if the input string's length is known.
1416 */
Gordon Henriksen931e1212008-02-02 01:07:50 +00001417LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001418
1419/**
1420 * Obtain a constant for a floating point value parsed from a string.
1421 */
Erick Tryzelaardd991352009-08-16 23:36:46 +00001422LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1423 unsigned SLen);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001424
1425/**
1426 * Obtain the zero extended value for an integer constant value.
1427 *
1428 * @see llvm::ConstantInt::getZExtValue()
1429 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001430unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001431
1432/**
1433 * Obtain the sign extended value for an integer constant value.
1434 *
1435 * @see llvm::ConstantInt::getSExtValue()
1436 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001437long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +00001438
Gregory Szorc34c863a2012-03-21 03:54:29 +00001439/**
1440 * @}
1441 */
1442
1443/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001444 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1445 *
1446 * Functions in this group operate on composite constants.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001447 *
1448 * @{
1449 */
1450
1451/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001452 * Create a ConstantDataSequential and initialize it with a string.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001453 *
Gregory Szorc52d26602012-03-21 07:28:27 +00001454 * @see llvm::ConstantDataArray::getString()
Gregory Szorc34c863a2012-03-21 03:54:29 +00001455 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001456LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +00001457 unsigned Length, LLVMBool DontNullTerminate);
Gregory Szorc52d26602012-03-21 07:28:27 +00001458
1459/**
1460 * Create a ConstantDataSequential with string content in the global context.
1461 *
1462 * This is the same as LLVMConstStringInContext except it operates on the
1463 * global context.
1464 *
1465 * @see LLVMConstStringInContext()
1466 * @see llvm::ConstantDataArray::getString()
1467 */
1468LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1469 LLVMBool DontNullTerminate);
1470
1471/**
1472 * Create an anonymous ConstantStruct with the specified values.
1473 *
1474 * @see llvm::ConstantStruct::getAnon()
1475 */
1476LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001477 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +00001478 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001479
Gregory Szorc52d26602012-03-21 07:28:27 +00001480/**
1481 * Create a ConstantStruct in the global Context.
1482 *
1483 * This is the same as LLVMConstStructInContext except it operates on the
1484 * global Context.
1485 *
1486 * @see LLVMConstStructInContext()
1487 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001488LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +00001489 LLVMBool Packed);
Gregory Szorc52d26602012-03-21 07:28:27 +00001490
1491/**
1492 * Create a ConstantArray from values.
1493 *
1494 * @see llvm::ConstantArray::get()
1495 */
1496LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1497 LLVMValueRef *ConstantVals, unsigned Length);
1498
1499/**
1500 * Create a non-anonymous ConstantStruct from values.
1501 *
1502 * @see llvm::ConstantStruct::get()
1503 */
Rafael Espindola784ad242011-07-14 19:09:08 +00001504LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1505 LLVMValueRef *ConstantVals,
1506 unsigned Count);
Gregory Szorc52d26602012-03-21 07:28:27 +00001507
1508/**
1509 * Create a ConstantVector from values.
1510 *
1511 * @see llvm::ConstantVector::get()
1512 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001513LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001514
Gregory Szorc52d26602012-03-21 07:28:27 +00001515/**
1516 * @}
1517 */
1518
1519/**
1520 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1521 *
1522 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1523 *
1524 * @see llvm::ConstantExpr.
1525 *
1526 * @{
1527 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001528LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +00001529LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001530LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1531LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001532LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1533LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001534LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001535LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1536LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +00001537LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001538LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001539LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001540LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001541LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1542LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001543LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001544LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001545LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1546LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001547LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001548LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1549LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +00001550LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001551LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1552LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1553LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1554LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1555LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1556LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1557LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1558LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1559 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1560LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1561 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1562LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1563LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1564LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1565LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1566 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +00001567LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1568 LLVMValueRef *ConstantIndices,
1569 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001570LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1571LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1572LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1573LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1574LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1575LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1576LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1577LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1578LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1579LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1580LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1581LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001582LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1583 LLVMTypeRef ToType);
1584LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1585 LLVMTypeRef ToType);
1586LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1587 LLVMTypeRef ToType);
1588LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1589 LLVMTypeRef ToType);
1590LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +00001591 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001592LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001593LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1594 LLVMValueRef ConstantIfTrue,
1595 LLVMValueRef ConstantIfFalse);
1596LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1597 LLVMValueRef IndexConstant);
1598LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1599 LLVMValueRef ElementValueConstant,
1600 LLVMValueRef IndexConstant);
1601LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1602 LLVMValueRef VectorBConstant,
1603 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +00001604LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1605 unsigned NumIdx);
1606LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1607 LLVMValueRef ElementValueConstant,
1608 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +00001609LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +00001610 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +00001611 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +00001612LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001613
Gregory Szorc52d26602012-03-21 07:28:27 +00001614/**
1615 * @}
1616 */
1617
1618/**
1619 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1620 *
1621 * This group contains functions that operate on global values. Functions in
1622 * this group relate to functions in the llvm::GlobalValue class tree.
1623 *
1624 * @see llvm::GlobalValue
1625 *
1626 * @{
1627 */
1628
Gordon Henriksen265f7802008-03-19 01:11:35 +00001629LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +00001630LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001631LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1632void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1633const char *LLVMGetSection(LLVMValueRef Global);
1634void LLVMSetSection(LLVMValueRef Global, const char *Section);
1635LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1636void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1637unsigned LLVMGetAlignment(LLVMValueRef Global);
1638void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
1639
Gregory Szorc52d26602012-03-21 07:28:27 +00001640/**
1641 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1642 *
1643 * This group contains functions that operate on global variable values.
1644 *
1645 * @see llvm::GlobalVariable
1646 *
1647 * @{
1648 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001649LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +00001650LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1651 const char *Name,
1652 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +00001653LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001654LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1655LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1656LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1657LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001658void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001659LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1660void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +00001661LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1662void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1663LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1664void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Hans Wennborg5ff71202013-04-16 08:58:59 +00001665LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1666void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1667LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1668void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001669
Gregory Szorc52d26602012-03-21 07:28:27 +00001670/**
1671 * @}
1672 */
1673
1674/**
1675 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1676 *
1677 * This group contains function that operate on global alias values.
1678 *
1679 * @see llvm::GlobalAlias
1680 *
1681 * @{
1682 */
Chris Lattner3d1f5522008-12-17 21:39:50 +00001683LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1684 const char *Name);
1685
Gregory Szorc34c863a2012-03-21 03:54:29 +00001686/**
1687 * @}
1688 */
1689
1690/**
1691 * @defgroup LLVMCCoreValueFunction Function values
1692 *
1693 * Functions in this group operate on LLVMValueRef instances that
1694 * correspond to llvm::Function instances.
1695 *
1696 * @see llvm::Function
1697 *
1698 * @{
1699 */
1700
1701/**
1702 * Remove a function from its containing module and deletes it.
1703 *
1704 * @see llvm::Function::eraseFromParent()
1705 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001706void LLVMDeleteFunction(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001707
1708/**
1709 * Obtain the ID number from a function instance.
1710 *
1711 * @see llvm::Function::getIntrinsicID()
1712 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001713unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001714
1715/**
1716 * Obtain the calling function of a function.
1717 *
1718 * The returned value corresponds to the LLVMCallConv enumeration.
1719 *
1720 * @see llvm::Function::getCallingConv()
1721 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001722unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001723
1724/**
1725 * Set the calling convention of a function.
1726 *
1727 * @see llvm::Function::setCallingConv()
1728 *
1729 * @param Fn Function to operate on
1730 * @param CC LLVMCallConv to set calling convention to
1731 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001732void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001733
1734/**
1735 * Obtain the name of the garbage collector to use during code
1736 * generation.
1737 *
1738 * @see llvm::Function::getGC()
1739 */
Gordon Henriksend930f912008-08-17 18:44:35 +00001740const char *LLVMGetGC(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001741
1742/**
1743 * Define the garbage collector to use during code generation.
1744 *
1745 * @see llvm::Function::setGC()
1746 */
Gordon Henriksend930f912008-08-17 18:44:35 +00001747void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001748
1749/**
1750 * Add an attribute to a function.
1751 *
1752 * @see llvm::Function::addAttribute()
1753 */
Duncan Sands7374a012009-05-06 12:21:17 +00001754void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001755
1756/**
Tom Stellarde8f35e12013-04-16 23:12:43 +00001757 * Add a target-dependent attribute to a fuction
1758 * @see llvm::AttrBuilder::addAttribute()
1759 */
1760void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1761 const char *V);
1762
1763/**
Gregory Szorc34c863a2012-03-21 03:54:29 +00001764 * Obtain an attribute from a function.
1765 *
1766 * @see llvm::Function::getAttributes()
1767 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001768LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001769
1770/**
1771 * Remove an attribute from a function.
1772 */
Duncan Sands7374a012009-05-06 12:21:17 +00001773void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001774
Gregory Szorc34c863a2012-03-21 03:54:29 +00001775/**
1776 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1777 *
1778 * Functions in this group relate to arguments/parameters on functions.
1779 *
1780 * Functions in this group expect LLVMValueRef instances that correspond
1781 * to llvm::Function instances.
1782 *
1783 * @{
1784 */
1785
1786/**
1787 * Obtain the number of parameters in a function.
1788 *
1789 * @see llvm::Function::arg_size()
1790 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001791unsigned LLVMCountParams(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001792
1793/**
1794 * Obtain the parameters in a function.
1795 *
1796 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1797 * at least LLVMCountParams() long. This array will be filled with
1798 * LLVMValueRef instances which correspond to the parameters the
1799 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1800 * instance.
1801 *
1802 * @see llvm::Function::arg_begin()
1803 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001804void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001805
1806/**
1807 * Obtain the parameter at the specified index.
1808 *
1809 * Parameters are indexed from 0.
1810 *
1811 * @see llvm::Function::arg_begin()
1812 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001813LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001814
1815/**
1816 * Obtain the function to which this argument belongs.
1817 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001818 * Unlike other functions in this group, this one takes an LLVMValueRef
Gregory Szorc34c863a2012-03-21 03:54:29 +00001819 * that corresponds to a llvm::Attribute.
1820 *
1821 * The returned LLVMValueRef is the llvm::Function to which this
1822 * argument belongs.
1823 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001824LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001825
1826/**
1827 * Obtain the first parameter to a function.
1828 *
1829 * @see llvm::Function::arg_begin()
1830 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001831LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001832
1833/**
1834 * Obtain the last parameter to a function.
1835 *
1836 * @see llvm::Function::arg_end()
1837 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001838LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001839
1840/**
1841 * Obtain the next parameter to a function.
1842 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001843 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
Gregory Szorc34c863a2012-03-21 03:54:29 +00001844 * actually a wrapped iterator) and obtains the next parameter from the
1845 * underlying iterator.
1846 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001847LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001848
1849/**
1850 * Obtain the previous parameter to a function.
1851 *
1852 * This is the opposite of LLVMGetNextParam().
1853 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001854LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001855
1856/**
1857 * Add an attribute to a function argument.
1858 *
1859 * @see llvm::Argument::addAttr()
1860 */
Devang Patel4c758ea2008-09-25 21:00:45 +00001861void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001862
1863/**
1864 * Remove an attribute from a function argument.
1865 *
1866 * @see llvm::Argument::removeAttr()
1867 */
Devang Patel4c758ea2008-09-25 21:00:45 +00001868void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001869
1870/**
1871 * Get an attribute from a function argument.
1872 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001873LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001874
1875/**
1876 * Set the alignment for a function parameter.
1877 *
1878 * @see llvm::Argument::addAttr()
Bill Wendling50d27842012-10-15 20:35:56 +00001879 * @see llvm::AttrBuilder::addAlignmentAttr()
Gregory Szorc34c863a2012-03-21 03:54:29 +00001880 */
Gordon Henriksen2d9cc212008-04-28 17:37:06 +00001881void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +00001882
Gregory Szorc34c863a2012-03-21 03:54:29 +00001883/**
1884 * @}
1885 */
1886
1887/**
1888 * @}
1889 */
1890
1891/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001892 * @}
1893 */
1894
1895/**
1896 * @}
1897 */
1898
1899/**
1900 * @defgroup LLVMCCoreValueMetadata Metadata
1901 *
1902 * @{
1903 */
1904
1905/**
1906 * Obtain a MDString value from a context.
1907 *
1908 * The returned instance corresponds to the llvm::MDString class.
1909 *
1910 * The instance is specified by string data of a specified length. The
1911 * string content is copied, so the backing memory can be freed after
1912 * this function returns.
1913 */
1914LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
1915 unsigned SLen);
1916
1917/**
1918 * Obtain a MDString value from the global context.
1919 */
1920LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
1921
1922/**
1923 * Obtain a MDNode value from a context.
1924 *
1925 * The returned value corresponds to the llvm::MDNode class.
1926 */
1927LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
1928 unsigned Count);
1929
1930/**
1931 * Obtain a MDNode value from the global context.
1932 */
1933LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
1934
1935/**
1936 * Obtain the underlying string from a MDString value.
1937 *
1938 * @param V Instance to obtain string from.
1939 * @param Len Memory address which will hold length of returned string.
1940 * @return String data in MDString.
1941 */
1942const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
1943
1944/**
Duncan Sands12ccbe72012-09-19 20:29:39 +00001945 * Obtain the number of operands from an MDNode value.
1946 *
1947 * @param V MDNode to get number of operands from.
1948 * @return Number of operands of the MDNode.
1949 */
1950unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
1951
1952/**
1953 * Obtain the given MDNode's operands.
1954 *
1955 * The passed LLVMValueRef pointer should point to enough memory to hold all of
1956 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
1957 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
1958 * MDNode's operands.
1959 *
1960 * @param V MDNode to get the operands from.
1961 * @param Dest Destination array for operands.
1962 */
1963void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
1964
1965/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001966 * @}
1967 */
1968
1969/**
Gregory Szorc34c863a2012-03-21 03:54:29 +00001970 * @defgroup LLVMCCoreValueBasicBlock Basic Block
1971 *
1972 * A basic block represents a single entry single exit section of code.
1973 * Basic blocks contain a list of instructions which form the body of
1974 * the block.
1975 *
1976 * Basic blocks belong to functions. They have the type of label.
1977 *
1978 * Basic blocks are themselves values. However, the C API models them as
1979 * LLVMBasicBlockRef.
1980 *
1981 * @see llvm::BasicBlock
1982 *
1983 * @{
1984 */
1985
1986/**
1987 * Convert a basic block instance to a value type.
1988 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001989LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001990
1991/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001992 * Determine whether an LLVMValueRef is itself a basic block.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001993 */
Chris Lattner25963c62010-01-09 22:27:07 +00001994LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001995
1996/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001997 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001998 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001999LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002000
2001/**
2002 * Obtain the function to which a basic block belongs.
2003 *
2004 * @see llvm::BasicBlock::getParent()
2005 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00002006LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002007
2008/**
2009 * Obtain the terminator instruction for a basic block.
2010 *
2011 * If the basic block does not have a terminator (it is not well-formed
2012 * if it doesn't), then NULL is returned.
2013 *
2014 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2015 *
2016 * @see llvm::BasicBlock::getTerminator()
2017 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002018LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002019
2020/**
2021 * Obtain the number of basic blocks in a function.
2022 *
2023 * @param Fn Function value to operate on.
2024 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002025unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002026
2027/**
2028 * Obtain all of the basic blocks in a function.
2029 *
2030 * This operates on a function value. The BasicBlocks parameter is a
2031 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2032 * LLVMCountBasicBlocks() in length. This array is populated with
2033 * LLVMBasicBlockRef instances.
2034 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002035void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002036
2037/**
2038 * Obtain the first basic block in a function.
2039 *
2040 * The returned basic block can be used as an iterator. You will likely
2041 * eventually call into LLVMGetNextBasicBlock() with it.
2042 *
2043 * @see llvm::Function::begin()
2044 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002045LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002046
2047/**
2048 * Obtain the last basic block in a function.
2049 *
2050 * @see llvm::Function::end()
2051 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002052LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002053
2054/**
2055 * Advance a basic block iterator.
2056 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002057LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002058
2059/**
2060 * Go backwards in a basic block iterator.
2061 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002062LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002063
2064/**
2065 * Obtain the basic block that corresponds to the entry point of a
2066 * function.
2067 *
2068 * @see llvm::Function::getEntryBlock()
2069 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002070LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002071
Gregory Szorc34c863a2012-03-21 03:54:29 +00002072/**
2073 * Append a basic block to the end of a function.
2074 *
2075 * @see llvm::BasicBlock::Create()
2076 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002077LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2078 LLVMValueRef Fn,
2079 const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002080
2081/**
2082 * Append a basic block to the end of a function using the global
2083 * context.
2084 *
2085 * @see llvm::BasicBlock::Create()
2086 */
2087LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2088
2089/**
2090 * Insert a basic block in a function before another basic block.
2091 *
2092 * The function to add to is determined by the function of the
2093 * passed basic block.
2094 *
2095 * @see llvm::BasicBlock::Create()
2096 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002097LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2098 LLVMBasicBlockRef BB,
2099 const char *Name);
2100
Gregory Szorc34c863a2012-03-21 03:54:29 +00002101/**
2102 * Insert a basic block in a function using the global context.
2103 *
2104 * @see llvm::BasicBlock::Create()
2105 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002106LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2107 const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002108
2109/**
2110 * Remove a basic block from a function and delete it.
2111 *
2112 * This deletes the basic block from its containing function and deletes
2113 * the basic block itself.
2114 *
2115 * @see llvm::BasicBlock::eraseFromParent()
2116 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002117void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002118
2119/**
2120 * Remove a basic block from a function.
2121 *
2122 * This deletes the basic block from its containing function but keep
2123 * the basic block alive.
2124 *
2125 * @see llvm::BasicBlock::removeFromParent()
2126 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002127void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002128
Gregory Szorc34c863a2012-03-21 03:54:29 +00002129/**
2130 * Move a basic block to before another one.
2131 *
2132 * @see llvm::BasicBlock::moveBefore()
2133 */
Duncan Sandsb1d61aa2010-07-19 15:31:07 +00002134void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002135
2136/**
2137 * Move a basic block to after another one.
2138 *
2139 * @see llvm::BasicBlock::moveAfter()
2140 */
Duncan Sandsb1d61aa2010-07-19 15:31:07 +00002141void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2142
Gregory Szorc34c863a2012-03-21 03:54:29 +00002143/**
2144 * Obtain the first instruction in a basic block.
2145 *
2146 * The returned LLVMValueRef corresponds to a llvm::Instruction
2147 * instance.
2148 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002149LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002150
2151/**
2152 * Obtain the last instruction in a basic block.
2153 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002154 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002155 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002156LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
Nate Begeman43c322b2011-08-23 20:27:46 +00002157
Gregory Szorc34c863a2012-03-21 03:54:29 +00002158/**
2159 * @}
2160 */
2161
2162/**
2163 * @defgroup LLVMCCoreValueInstruction Instructions
2164 *
2165 * Functions in this group relate to the inspection and manipulation of
2166 * individual instructions.
2167 *
2168 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2169 * class has a large number of descendents. llvm::Instruction is a
2170 * llvm::Value and in the C API, instructions are modeled by
2171 * LLVMValueRef.
2172 *
2173 * This group also contains sub-groups which operate on specific
2174 * llvm::Instruction types, e.g. llvm::CallInst.
2175 *
2176 * @{
2177 */
2178
2179/**
2180 * Determine whether an instruction has any metadata attached.
2181 */
2182int LLVMHasMetadata(LLVMValueRef Val);
2183
2184/**
2185 * Return metadata associated with an instruction value.
2186 */
2187LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2188
2189/**
2190 * Set metadata associated with an instruction value.
2191 */
2192void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2193
2194/**
2195 * Obtain the basic block to which an instruction belongs.
2196 *
2197 * @see llvm::Instruction::getParent()
2198 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002199LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002200
2201/**
2202 * Obtain the instruction that occurs after the one specified.
2203 *
2204 * The next instruction will be from the same basic block.
2205 *
2206 * If this is the last instruction in a basic block, NULL will be
2207 * returned.
2208 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002209LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002210
2211/**
Benjamin Kramerbde91762012-06-02 10:20:22 +00002212 * Obtain the instruction that occurred before this one.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002213 *
2214 * If the instruction is the first instruction in a basic block, NULL
2215 * will be returned.
2216 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002217LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002218
2219/**
2220 * Remove and delete an instruction.
2221 *
2222 * The instruction specified is removed from its containing building
2223 * block and then deleted.
2224 *
2225 * @see llvm::Instruction::eraseFromParent()
2226 */
Devang Pateldbebc6f2011-10-03 20:59:18 +00002227void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002228
2229/**
2230 * Obtain the code opcode for an individual instruction.
2231 *
2232 * @see llvm::Instruction::getOpCode()
2233 */
Torok Edwinab6158e2011-10-14 20:37:49 +00002234LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002235
2236/**
2237 * Obtain the predicate of an instruction.
2238 *
2239 * This is only valid for instructions that correspond to llvm::ICmpInst
2240 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2241 *
2242 * @see llvm::ICmpInst::getPredicate()
2243 */
Torok Edwin60c40de2011-10-06 12:13:20 +00002244LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +00002245
Gregory Szorc34c863a2012-03-21 03:54:29 +00002246/**
2247 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2248 *
2249 * Functions in this group apply to instructions that refer to call
2250 * sites and invocations. These correspond to C++ types in the
2251 * llvm::CallInst class tree.
2252 *
2253 * @{
2254 */
2255
2256/**
2257 * Set the calling convention for a call instruction.
2258 *
2259 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2260 * llvm::InvokeInst.
2261 *
2262 * @see llvm::CallInst::setCallingConv()
2263 * @see llvm::InvokeInst::setCallingConv()
2264 */
Gordon Henriksen1158c532007-12-29 20:45:00 +00002265void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002266
2267/**
2268 * Obtain the calling convention for a call instruction.
2269 *
2270 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2271 * usage.
2272 *
2273 * @see LLVMSetInstructionCallConv()
2274 */
Gordon Henriksen1158c532007-12-29 20:45:00 +00002275unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002276
2277
Devang Patel4c758ea2008-09-25 21:00:45 +00002278void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002279void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
Devang Patel4c758ea2008-09-25 21:00:45 +00002280 LLVMAttribute);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002281void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
Gordon Henriksen2d9cc212008-04-28 17:37:06 +00002282 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +00002283
Gregory Szorc34c863a2012-03-21 03:54:29 +00002284/**
2285 * Obtain whether a call instruction is a tail call.
2286 *
2287 * This only works on llvm::CallInst instructions.
2288 *
2289 * @see llvm::CallInst::isTailCall()
2290 */
Chris Lattner25963c62010-01-09 22:27:07 +00002291LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002292
2293/**
2294 * Set whether a call instruction is a tail call.
2295 *
2296 * This only works on llvm::CallInst instructions.
2297 *
2298 * @see llvm::CallInst::setTailCall()
2299 */
Chris Lattner25963c62010-01-09 22:27:07 +00002300void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +00002301
Gregory Szorc34c863a2012-03-21 03:54:29 +00002302/**
2303 * @}
2304 */
2305
2306/**
2307 * Obtain the default destination basic block of a switch instruction.
2308 *
2309 * This only works on llvm::SwitchInst instructions.
2310 *
2311 * @see llvm::SwitchInst::getDefaultDest()
2312 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002313LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2314
Gregory Szorc34c863a2012-03-21 03:54:29 +00002315/**
2316 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2317 *
2318 * Functions in this group only apply to instructions that map to
2319 * llvm::PHINode instances.
2320 *
2321 * @{
2322 */
2323
2324/**
2325 * Add an incoming value to the end of a PHI list.
2326 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002327void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2328 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002329
2330/**
2331 * Obtain the number of incoming basic blocks to a PHI node.
2332 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002333unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002334
2335/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002336 * Obtain an incoming value to a PHI node as an LLVMValueRef.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002337 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002338LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002339
2340/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002341 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002342 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002343LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002344
Gregory Szorc34c863a2012-03-21 03:54:29 +00002345/**
2346 * @}
2347 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002348
Gregory Szorc34c863a2012-03-21 03:54:29 +00002349/**
2350 * @}
2351 */
2352
2353/**
2354 * @}
2355 */
2356
2357/**
2358 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2359 *
2360 * An instruction builder represents a point within a basic block and is
2361 * the exclusive means of building instructions using the C interface.
2362 *
2363 * @{
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002364 */
2365
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002366LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +00002367LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +00002368void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2369 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002370void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2371void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +00002372LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +00002373void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2374void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +00002375void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2376 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002377void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2378
Erick Tryzelaard8531fa2010-02-28 09:45:59 +00002379/* Metadata */
2380void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2381LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2382void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2383
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002384/* Terminators */
2385LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2386LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +00002387LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002388 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002389LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2390LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2391 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2392LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2393 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +00002394LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2395 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002396LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2397 LLVMValueRef *Args, unsigned NumArgs,
2398 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2399 const char *Name);
Benjamin Kramer5a6568832011-08-19 01:36:54 +00002400LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2401 LLVMValueRef PersFn, unsigned NumClauses,
2402 const char *Name);
Bill Wendlingf891bf82011-07-31 06:30:59 +00002403LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002404LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2405
Gordon Henriksen097102c2008-01-01 05:50:53 +00002406/* Add a case to the switch instruction */
2407void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2408 LLVMBasicBlockRef Dest);
2409
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +00002410/* Add a destination to the indirectbr instruction */
2411void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2412
Bill Wendlingfae14752011-08-12 20:24:12 +00002413/* Add a catch or filter clause to the landingpad instruction */
2414void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2415
2416/* Set the 'cleanup' flag in the landingpad instruction */
2417void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2418
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002419/* Arithmetic */
2420LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2421 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002422LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2423 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002424LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2425 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002426LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2427 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002428LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2429 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002430LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2431 const char *Name);
2432LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2433 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002434LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2435 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002436LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2437 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002438LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2439 const char *Name);
2440LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2441 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002442LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2443 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002444LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2445 const char *Name);
2446LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2447 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002448LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2449 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002450LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2451 const char *Name);
2452LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2453 const char *Name);
2454LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2455 const char *Name);
2456LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2457 const char *Name);
2458LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2459 const char *Name);
2460LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2461 const char *Name);
2462LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2463 const char *Name);
2464LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2465 const char *Name);
2466LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2467 const char *Name);
2468LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2469 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +00002470LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2471 LLVMValueRef LHS, LLVMValueRef RHS,
2472 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002473LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002474LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2475 const char *Name);
2476LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2477 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +00002478LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002479LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2480
2481/* Memory */
2482LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2483LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2484 LLVMValueRef Val, const char *Name);
2485LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2486LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2487 LLVMValueRef Val, const char *Name);
2488LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2489LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2490 const char *Name);
2491LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2492LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2493 LLVMValueRef *Indices, unsigned NumIndices,
2494 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002495LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2496 LLVMValueRef *Indices, unsigned NumIndices,
2497 const char *Name);
2498LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2499 unsigned Idx, const char *Name);
2500LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2501 const char *Name);
2502LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2503 const char *Name);
Chris Lattner2cc6f9d2012-03-22 03:54:15 +00002504LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2505void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002506
2507/* Casts */
2508LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2509 LLVMTypeRef DestTy, const char *Name);
2510LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2511 LLVMTypeRef DestTy, const char *Name);
2512LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2513 LLVMTypeRef DestTy, const char *Name);
2514LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2515 LLVMTypeRef DestTy, const char *Name);
2516LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2517 LLVMTypeRef DestTy, const char *Name);
2518LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2519 LLVMTypeRef DestTy, const char *Name);
2520LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2521 LLVMTypeRef DestTy, const char *Name);
2522LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2523 LLVMTypeRef DestTy, const char *Name);
2524LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2525 LLVMTypeRef DestTy, const char *Name);
2526LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2527 LLVMTypeRef DestTy, const char *Name);
2528LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2529 LLVMTypeRef DestTy, const char *Name);
2530LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2531 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002532LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2533 LLVMTypeRef DestTy, const char *Name);
2534LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2535 LLVMTypeRef DestTy, const char *Name);
2536LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2537 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +00002538LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2539 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002540LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2541 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +00002542LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002543 LLVMTypeRef DestTy, const char *Name);
2544LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2545 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002546
2547/* Comparisons */
2548LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2549 LLVMValueRef LHS, LLVMValueRef RHS,
2550 const char *Name);
2551LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2552 LLVMValueRef LHS, LLVMValueRef RHS,
2553 const char *Name);
2554
2555/* Miscellaneous instructions */
2556LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2557LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2558 LLVMValueRef *Args, unsigned NumArgs,
2559 const char *Name);
2560LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2561 LLVMValueRef Then, LLVMValueRef Else,
2562 const char *Name);
2563LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2564 const char *Name);
2565LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2566 LLVMValueRef Index, const char *Name);
2567LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2568 LLVMValueRef EltVal, LLVMValueRef Index,
2569 const char *Name);
2570LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2571 LLVMValueRef V2, LLVMValueRef Mask,
2572 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +00002573LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2574 unsigned Index, const char *Name);
2575LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2576 LLVMValueRef EltVal, unsigned Index,
2577 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +00002578
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002579LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2580 const char *Name);
2581LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2582 const char *Name);
2583LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2584 LLVMValueRef RHS, const char *Name);
Carlo Kok8c6719b2013-04-23 13:21:19 +00002585LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B,LLVMAtomicRMWBinOp op,
2586 LLVMValueRef PTR, LLVMValueRef Val,
2587 LLVMAtomicOrdering ordering,
2588 LLVMBool singleThread);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002589
Gregory Szorc34c863a2012-03-21 03:54:29 +00002590/**
2591 * @}
2592 */
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002593
Gregory Szorc34c863a2012-03-21 03:54:29 +00002594/**
2595 * @defgroup LLVMCCoreModuleProvider Module Providers
2596 *
2597 * @{
2598 */
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002599
Gregory Szorc34c863a2012-03-21 03:54:29 +00002600/**
2601 * Changes the type of M so it can be passed to FunctionPassManagers and the
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002602 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002603 */
2604LLVMModuleProviderRef
2605LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2606
Gregory Szorc34c863a2012-03-21 03:54:29 +00002607/**
2608 * Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002609 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002610void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002611
Gregory Szorc34c863a2012-03-21 03:54:29 +00002612/**
2613 * @}
2614 */
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002615
Gregory Szorc34c863a2012-03-21 03:54:29 +00002616/**
2617 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2618 *
2619 * @{
2620 */
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002621
Chris Lattner25963c62010-01-09 22:27:07 +00002622LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2623 LLVMMemoryBufferRef *OutMemBuf,
2624 char **OutMessage);
2625LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2626 char **OutMessage);
Bill Wendling526276a2013-02-14 19:11:28 +00002627LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2628 size_t InputDataLength,
2629 const char *BufferName,
Bill Wendlingc9baa962013-02-14 19:39:14 +00002630 LLVMBool RequiresNullTerminator);
Bill Wendling526276a2013-02-14 19:11:28 +00002631LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2632 size_t InputDataLength,
2633 const char *BufferName);
Tom Stellard62c03202013-04-18 19:50:53 +00002634const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
Tom Stellardb7fb7242013-04-16 23:12:51 +00002635size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002636void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2637
Gregory Szorc34c863a2012-03-21 03:54:29 +00002638/**
2639 * @}
2640 */
2641
2642/**
2643 * @defgroup LLVMCCorePassRegistry Pass Registry
2644 *
2645 * @{
2646 */
Owen Anderson4698c5d2010-10-07 17:55:47 +00002647
2648/** Return the global pass registry, for use with initialization functions.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002649 @see llvm::PassRegistry::getPassRegistry */
Owen Anderson4698c5d2010-10-07 17:55:47 +00002650LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002651
Gregory Szorc34c863a2012-03-21 03:54:29 +00002652/**
2653 * @}
2654 */
2655
2656/**
2657 * @defgroup LLVMCCorePassManagers Pass Managers
2658 *
2659 * @{
2660 */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002661
2662/** Constructs a new whole-module pass pipeline. This type of pipeline is
2663 suitable for link-time optimization and whole-module transformations.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002664 @see llvm::PassManager::PassManager */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00002665LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002666
2667/** Constructs a new function-by-function pass pipeline over the module
2668 provider. It does not take ownership of the module provider. This type of
2669 pipeline is suitable for code generation and JIT compilation tasks.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002670 @see llvm::FunctionPassManager::FunctionPassManager */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00002671LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2672
2673/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002674LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2675
2676/** Initializes, executes on the provided module, and finalizes all of the
2677 passes scheduled in the pass manager. Returns 1 if any of the passes
Gregory Szorc34c863a2012-03-21 03:54:29 +00002678 modified the module, 0 otherwise.
2679 @see llvm::PassManager::run(Module&) */
Chris Lattner25963c62010-01-09 22:27:07 +00002680LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002681
2682/** Initializes all of the function passes scheduled in the function pass
2683 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002684 @see llvm::FunctionPassManager::doInitialization */
Chris Lattner25963c62010-01-09 22:27:07 +00002685LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002686
2687/** Executes all of the function passes scheduled in the function pass manager
2688 on the provided function. Returns 1 if any of the passes modified the
2689 function, false otherwise.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002690 @see llvm::FunctionPassManager::run(Function&) */
Chris Lattner25963c62010-01-09 22:27:07 +00002691LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002692
2693/** Finalizes all of the function passes scheduled in in the function pass
2694 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002695 @see llvm::FunctionPassManager::doFinalization */
Chris Lattner25963c62010-01-09 22:27:07 +00002696LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002697
2698/** Frees the memory of a pass pipeline. For function pipelines, does not free
2699 the module provider.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002700 @see llvm::PassManagerBase::~PassManagerBase. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002701void LLVMDisposePassManager(LLVMPassManagerRef PM);
2702
Gregory Szorc34c863a2012-03-21 03:54:29 +00002703/**
2704 * @}
2705 */
2706
2707/**
Duncan Sands1cba0a82013-02-17 16:35:51 +00002708 * @defgroup LLVMCCoreThreading Threading
2709 *
2710 * Handle the structures needed to make LLVM safe for multithreading.
2711 *
2712 * @{
2713 */
2714
2715/** Allocate and initialize structures needed to make LLVM safe for
2716 multithreading. The return value indicates whether multithreaded
2717 initialization succeeded. Must be executed in isolation from all
2718 other LLVM api calls.
2719 @see llvm::llvm_start_multithreaded */
2720LLVMBool LLVMStartMultithreaded();
2721
2722/** Deallocate structures necessary to make LLVM safe for multithreading.
2723 Must be executed in isolation from all other LLVM api calls.
2724 @see llvm::llvm_stop_multithreaded */
2725void LLVMStopMultithreaded();
2726
2727/** Check whether LLVM is executing in thread-safe mode or not.
2728 @see llvm::llvm_is_multithreaded */
2729LLVMBool LLVMIsMultithreaded();
2730
2731/**
2732 * @}
2733 */
2734
2735/**
Gregory Szorc34c863a2012-03-21 03:54:29 +00002736 * @}
2737 */
2738
2739/**
2740 * @}
2741 */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002742
Gordon Henriksen76a03742007-09-18 03:18:57 +00002743#ifdef __cplusplus
2744}
Evan Cheng2e254d02013-04-04 17:40:53 +00002745#endif /* !defined(__cplusplus) */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00002746
Evan Cheng2e254d02013-04-04 17:40:53 +00002747#endif /* !defined(LLVM_C_CORE_H) */