blob: d39128db1a6d0322627d4ae123702dafcf69a8a9 [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/**
Anders Waldenborgb822cff2013-10-16 21:30:25 +0000703 * Dump a representation of a type to stderr.
704 *
705 * @see llvm::Type::dump()
706 */
707void LLVMDumpType(LLVMTypeRef Val);
708
709/**
Gregory Szorc34c863a2012-03-21 03:54:29 +0000710 * @defgroup LLVMCCoreTypeInt Integer Types
711 *
712 * Functions in this section operate on integer types.
713 *
714 * @{
715 */
716
717/**
718 * Obtain an integer type from a context with specified bit width.
719 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000720LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
721LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
722LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
723LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
724LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
725LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
726
Gregory Szorc34c863a2012-03-21 03:54:29 +0000727/**
728 * Obtain an integer type from the global context with a specified bit
729 * width.
730 */
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000731LLVMTypeRef LLVMInt1Type(void);
732LLVMTypeRef LLVMInt8Type(void);
733LLVMTypeRef LLVMInt16Type(void);
734LLVMTypeRef LLVMInt32Type(void);
735LLVMTypeRef LLVMInt64Type(void);
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000736LLVMTypeRef LLVMIntType(unsigned NumBits);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000737unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000738
Gregory Szorc34c863a2012-03-21 03:54:29 +0000739/**
740 * @}
741 */
742
743/**
744 * @defgroup LLVMCCoreTypeFloat Floating Point Types
745 *
746 * @{
747 */
748
749/**
750 * Obtain a 16-bit floating point type from a context.
751 */
Dan Gohman518cda42011-12-17 00:04:22 +0000752LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000753
754/**
755 * Obtain a 32-bit floating point type from a context.
756 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000757LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000758
759/**
760 * Obtain a 64-bit floating point type from a context.
761 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000762LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000763
764/**
765 * Obtain a 80-bit floating point type (X87) from a context.
766 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000767LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000768
769/**
770 * Obtain a 128-bit floating point type (112-bit mantissa) from a
771 * context.
772 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000773LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000774
775/**
776 * Obtain a 128-bit floating point type (two 64-bits) from a context.
777 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000778LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
779
Gregory Szorc34c863a2012-03-21 03:54:29 +0000780/**
781 * Obtain a floating point type from the global context.
782 *
783 * These map to the functions in this group of the same name.
784 */
Dan Gohman518cda42011-12-17 00:04:22 +0000785LLVMTypeRef LLVMHalfType(void);
Gordon Henriksena735a9c2008-05-04 12:55:34 +0000786LLVMTypeRef LLVMFloatType(void);
787LLVMTypeRef LLVMDoubleType(void);
788LLVMTypeRef LLVMX86FP80Type(void);
789LLVMTypeRef LLVMFP128Type(void);
790LLVMTypeRef LLVMPPCFP128Type(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000791
Gregory Szorc34c863a2012-03-21 03:54:29 +0000792/**
793 * @}
794 */
795
796/**
797 * @defgroup LLVMCCoreTypeFunction Function Types
798 *
799 * @{
800 */
801
802/**
803 * Obtain a function type consisting of a specified signature.
804 *
805 * The function is defined as a tuple of a return Type, a list of
806 * parameter types, and whether the function is variadic.
807 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000808LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
809 LLVMTypeRef *ParamTypes, unsigned ParamCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000810 LLVMBool IsVarArg);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000811
812/**
813 * Returns whether a function type is variadic.
814 */
Chris Lattner25963c62010-01-09 22:27:07 +0000815LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000816
817/**
818 * Obtain the Type this function Type returns.
819 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000820LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000821
822/**
823 * Obtain the number of parameters this function accepts.
824 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000825unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000826
827/**
828 * Obtain the types of a function's parameters.
829 *
830 * The Dest parameter should point to a pre-allocated array of
831 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
832 * first LLVMCountParamTypes() entries in the array will be populated
833 * with LLVMTypeRef instances.
834 *
835 * @param FunctionTy The function type to operate on.
836 * @param Dest Memory address of an array to be filled with result.
837 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000838void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000839
Gregory Szorc34c863a2012-03-21 03:54:29 +0000840/**
841 * @}
842 */
843
844/**
845 * @defgroup LLVMCCoreTypeStruct Structure Types
846 *
847 * These functions relate to LLVMTypeRef instances.
848 *
849 * @see llvm::StructType
850 *
851 * @{
852 */
853
854/**
855 * Create a new structure type in a context.
856 *
857 * A structure is specified by a list of inner elements/types and
858 * whether these can be packed together.
859 *
860 * @see llvm::StructType::create()
861 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +0000862LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
Chris Lattner25963c62010-01-09 22:27:07 +0000863 unsigned ElementCount, LLVMBool Packed);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000864
865/**
866 * Create a new structure type in the global context.
867 *
868 * @see llvm::StructType::create()
869 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000870LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
Chris Lattner25963c62010-01-09 22:27:07 +0000871 LLVMBool Packed);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000872
873/**
874 * Create an empty structure in a context having a specified name.
875 *
876 * @see llvm::StructType::create()
877 */
Chris Lattnere71ccde2011-07-14 05:53:17 +0000878LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000879
880/**
881 * Obtain the name of a structure.
882 *
883 * @see llvm::StructType::getName()
884 */
Torok Edwin0d5f6ae2011-10-06 12:12:50 +0000885const char *LLVMGetStructName(LLVMTypeRef Ty);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000886
887/**
888 * Set the contents of a structure type.
889 *
890 * @see llvm::StructType::setBody()
891 */
Chris Lattnere71ccde2011-07-14 05:53:17 +0000892void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
893 unsigned ElementCount, LLVMBool Packed);
894
Gregory Szorc34c863a2012-03-21 03:54:29 +0000895/**
896 * Get the number of elements defined inside the structure.
897 *
898 * @see llvm::StructType::getNumElements()
899 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +0000900unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000901
902/**
903 * Get the elements within a structure.
904 *
905 * The function is passed the address of a pre-allocated array of
906 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
907 * invocation, this array will be populated with the structure's
908 * elements. The objects in the destination array will have a lifetime
909 * of the structure type itself, which is the lifetime of the context it
910 * is contained in.
911 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000912void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000913
914/**
915 * Determine whether a structure is packed.
916 *
917 * @see llvm::StructType::isPacked()
918 */
Chris Lattner25963c62010-01-09 22:27:07 +0000919LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000920
921/**
922 * Determine whether a structure is opaque.
923 *
924 * @see llvm::StructType::isOpaque()
925 */
Chris Lattner17cf05b2011-07-14 16:20:28 +0000926LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
927
Gregory Szorc34c863a2012-03-21 03:54:29 +0000928/**
929 * @}
930 */
Gordon Henriksen76a03742007-09-18 03:18:57 +0000931
Gregory Szorc34c863a2012-03-21 03:54:29 +0000932
933/**
934 * @defgroup LLVMCCoreTypeSequential Sequential Types
935 *
936 * Sequential types represents "arrays" of types. This is a super class
937 * for array, vector, and pointer types.
938 *
939 * @{
940 */
941
942/**
943 * Obtain the type of elements within a sequential type.
944 *
945 * This works on array, vector, and pointer types.
946 *
947 * @see llvm::SequentialType::getElementType()
948 */
949LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
950
951/**
952 * Create a fixed size array type that refers to a specific type.
953 *
954 * The created type will exist in the context that its element type
955 * exists in.
956 *
957 * @see llvm::ArrayType::get()
958 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000959LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000960
961/**
962 * Obtain the length of an array type.
963 *
964 * This only works on types that represent arrays.
965 *
966 * @see llvm::ArrayType::getNumElements()
967 */
968unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
969
970/**
971 * Create a pointer type that points to a defined type.
972 *
973 * The created type will exist in the context that its pointee type
974 * exists in.
975 *
976 * @see llvm::PointerType::get()
977 */
Gordon Henriksen5a3fe032007-12-17 16:08:32 +0000978LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
Gregory Szorc34c863a2012-03-21 03:54:29 +0000979
980/**
981 * Obtain the address space of a pointer type.
982 *
983 * This only works on types that represent pointers.
984 *
985 * @see llvm::PointerType::getAddressSpace()
986 */
987unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
988
989/**
990 * Create a vector type that contains a defined type and has a specific
991 * number of elements.
992 *
993 * The created type will exist in the context thats its element type
994 * exists in.
995 *
996 * @see llvm::VectorType::get()
997 */
Gordon Henriksened7beaa2007-10-06 16:05:20 +0000998LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
Gordon Henriksen76a03742007-09-18 03:18:57 +0000999
Gregory Szorc34c863a2012-03-21 03:54:29 +00001000/**
1001 * Obtain the number of elements in a vector type.
1002 *
1003 * This only works on types that represent vectors.
1004 *
1005 * @see llvm::VectorType::getNumElements()
1006 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001007unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1008
Gregory Szorc34c863a2012-03-21 03:54:29 +00001009/**
1010 * @}
1011 */
1012
1013/**
1014 * @defgroup LLVMCCoreTypeOther Other Types
1015 *
1016 * @{
1017 */
1018
1019/**
1020 * Create a void type in a context.
1021 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001022LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001023
1024/**
1025 * Create a label type in a context.
1026 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001027LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001028
1029/**
1030 * Create a X86 MMX type in a context.
1031 */
Dale Johannesen95b67af2010-09-10 21:58:02 +00001032LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001033
Gregory Szorc34c863a2012-03-21 03:54:29 +00001034/**
1035 * These are similar to the above functions except they operate on the
1036 * global context.
1037 */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00001038LLVMTypeRef LLVMVoidType(void);
1039LLVMTypeRef LLVMLabelType(void);
Dale Johannesen95b67af2010-09-10 21:58:02 +00001040LLVMTypeRef LLVMX86MMXType(void);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001041
Gregory Szorc34c863a2012-03-21 03:54:29 +00001042/**
1043 * @}
1044 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001045
Gregory Szorc34c863a2012-03-21 03:54:29 +00001046/**
1047 * @}
1048 */
1049
1050/**
1051 * @defgroup LLVMCCoreValues Values
1052 *
1053 * The bulk of LLVM's object model consists of values, which comprise a very
Gordon Henriksen76a03742007-09-18 03:18:57 +00001054 * rich type hierarchy.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001055 *
1056 * LLVMValueRef essentially represents llvm::Value. There is a rich
1057 * hierarchy of classes within this type. Depending on the instance
Eli Benderskyc52863c2012-08-10 18:30:44 +00001058 * obtained, not all APIs are available.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001059 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001060 * Callers can determine the type of an LLVMValueRef by calling the
Gregory Szorc34c863a2012-03-21 03:54:29 +00001061 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1062 * functions are defined by a macro, so it isn't obvious which are
1063 * available by looking at the Doxygen source code. Instead, look at the
1064 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1065 * of value names given. These value names also correspond to classes in
1066 * the llvm::Value hierarchy.
1067 *
1068 * @{
Gordon Henriksen76a03742007-09-18 03:18:57 +00001069 */
1070
Gordon Henriksen29e38942008-12-19 18:39:45 +00001071#define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1072 macro(Argument) \
1073 macro(BasicBlock) \
1074 macro(InlineAsm) \
Torok Edwind09b7572011-10-14 20:37:56 +00001075 macro(MDNode) \
1076 macro(MDString) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001077 macro(User) \
1078 macro(Constant) \
Torok Edwind09b7572011-10-14 20:37:56 +00001079 macro(BlockAddress) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001080 macro(ConstantAggregateZero) \
1081 macro(ConstantArray) \
1082 macro(ConstantExpr) \
1083 macro(ConstantFP) \
1084 macro(ConstantInt) \
1085 macro(ConstantPointerNull) \
1086 macro(ConstantStruct) \
1087 macro(ConstantVector) \
1088 macro(GlobalValue) \
1089 macro(Function) \
1090 macro(GlobalAlias) \
1091 macro(GlobalVariable) \
1092 macro(UndefValue) \
1093 macro(Instruction) \
1094 macro(BinaryOperator) \
1095 macro(CallInst) \
1096 macro(IntrinsicInst) \
1097 macro(DbgInfoIntrinsic) \
1098 macro(DbgDeclareInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001099 macro(MemIntrinsic) \
1100 macro(MemCpyInst) \
1101 macro(MemMoveInst) \
1102 macro(MemSetInst) \
1103 macro(CmpInst) \
Torok Edwind09b7572011-10-14 20:37:56 +00001104 macro(FCmpInst) \
1105 macro(ICmpInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001106 macro(ExtractElementInst) \
1107 macro(GetElementPtrInst) \
1108 macro(InsertElementInst) \
1109 macro(InsertValueInst) \
Bill Wendlingfae14752011-08-12 20:24:12 +00001110 macro(LandingPadInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001111 macro(PHINode) \
1112 macro(SelectInst) \
1113 macro(ShuffleVectorInst) \
1114 macro(StoreInst) \
1115 macro(TerminatorInst) \
1116 macro(BranchInst) \
Torok Edwind09b7572011-10-14 20:37:56 +00001117 macro(IndirectBrInst) \
Gordon Henriksen29e38942008-12-19 18:39:45 +00001118 macro(InvokeInst) \
1119 macro(ReturnInst) \
1120 macro(SwitchInst) \
1121 macro(UnreachableInst) \
Bill Wendlingf891bf82011-07-31 06:30:59 +00001122 macro(ResumeInst) \
Duncan Sands5e37e992013-05-06 08:55:45 +00001123 macro(UnaryInstruction) \
1124 macro(AllocaInst) \
1125 macro(CastInst) \
1126 macro(BitCastInst) \
1127 macro(FPExtInst) \
1128 macro(FPToSIInst) \
1129 macro(FPToUIInst) \
1130 macro(FPTruncInst) \
1131 macro(IntToPtrInst) \
1132 macro(PtrToIntInst) \
1133 macro(SExtInst) \
1134 macro(SIToFPInst) \
1135 macro(TruncInst) \
1136 macro(UIToFPInst) \
1137 macro(ZExtInst) \
1138 macro(ExtractValueInst) \
1139 macro(LoadInst) \
1140 macro(VAArgInst)
Gordon Henriksen29e38942008-12-19 18:39:45 +00001141
Gregory Szorc34c863a2012-03-21 03:54:29 +00001142/**
1143 * @defgroup LLVMCCoreValueGeneral General APIs
1144 *
1145 * Functions in this section work on all LLVMValueRef instances,
1146 * regardless of their sub-type. They correspond to functions available
1147 * on llvm::Value.
1148 *
1149 * @{
1150 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001151
Gregory Szorc34c863a2012-03-21 03:54:29 +00001152/**
1153 * Obtain the type of a value.
1154 *
1155 * @see llvm::Value::getType()
1156 */
1157LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1158
1159/**
1160 * Obtain the string name of a value.
1161 *
1162 * @see llvm::Value::getName()
1163 */
1164const char *LLVMGetValueName(LLVMValueRef Val);
1165
1166/**
1167 * Set the string name of a value.
1168 *
1169 * @see llvm::Value::setName()
1170 */
1171void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1172
1173/**
1174 * Dump a representation of a value to stderr.
1175 *
1176 * @see llvm::Value::dump()
1177 */
1178void LLVMDumpValue(LLVMValueRef Val);
1179
1180/**
1181 * Replace all uses of a value with another one.
1182 *
1183 * @see llvm::Value::replaceAllUsesWith()
1184 */
1185void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1186
1187/**
1188 * Determine whether the specified constant instance is constant.
1189 */
1190LLVMBool LLVMIsConstant(LLVMValueRef Val);
1191
1192/**
1193 * Determine whether a value instance is undefined.
1194 */
1195LLVMBool LLVMIsUndef(LLVMValueRef Val);
1196
1197/**
1198 * Convert value instances between types.
1199 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001200 * Internally, an LLVMValueRef is "pinned" to a specific type. This
Gregory Szorc34c863a2012-03-21 03:54:29 +00001201 * series of functions allows you to cast an instance to a specific
1202 * type.
1203 *
1204 * If the cast is not valid for the specified type, NULL is returned.
1205 *
1206 * @see llvm::dyn_cast_or_null<>
1207 */
Gordon Henriksen29e38942008-12-19 18:39:45 +00001208#define LLVM_DECLARE_VALUE_CAST(name) \
1209 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1210LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1211
Gregory Szorc34c863a2012-03-21 03:54:29 +00001212/**
1213 * @}
1214 */
1215
1216/**
1217 * @defgroup LLVMCCoreValueUses Usage
1218 *
1219 * This module defines functions that allow you to inspect the uses of a
1220 * LLVMValueRef.
1221 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001222 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001223 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1224 * llvm::User and llvm::Value.
1225 *
1226 * @{
1227 */
1228
1229/**
1230 * Obtain the first use of a value.
1231 *
1232 * Uses are obtained in an iterator fashion. First, call this function
1233 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
Eli Benderskyc52863c2012-08-10 18:30:44 +00001234 * on that instance and all subsequently obtained instances until
Gregory Szorc34c863a2012-03-21 03:54:29 +00001235 * LLVMGetNextUse() returns NULL.
1236 *
1237 * @see llvm::Value::use_begin()
1238 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001239LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001240
1241/**
1242 * Obtain the next use of a value.
1243 *
1244 * This effectively advances the iterator. It returns NULL if you are on
1245 * the final use and no more are available.
1246 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001247LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001248
1249/**
1250 * Obtain the user value for a user.
1251 *
1252 * The returned value corresponds to a llvm::User type.
1253 *
1254 * @see llvm::Use::getUser()
1255 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001256LLVMValueRef LLVMGetUser(LLVMUseRef U);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001257
1258/**
1259 * Obtain the value this use corresponds to.
1260 *
1261 * @see llvm::Use::get().
1262 */
Erick Tryzelaar9f9857e2010-03-02 20:32:28 +00001263LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
Chris Lattner40cf28d2009-10-12 04:01:02 +00001264
Gregory Szorc34c863a2012-03-21 03:54:29 +00001265/**
1266 * @}
1267 */
1268
1269/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001270 * @defgroup LLVMCCoreValueUser User value
Gregory Szorc34c863a2012-03-21 03:54:29 +00001271 *
1272 * Function in this group pertain to LLVMValueRef instances that descent
1273 * from llvm::User. This includes constants, instructions, and
1274 * operators.
1275 *
1276 * @{
1277 */
1278
1279/**
1280 * Obtain an operand at a specific index in a llvm::User value.
1281 *
1282 * @see llvm::User::getOperand()
1283 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001284LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001285
1286/**
1287 * Set an operand at a specific index in a llvm::User value.
1288 *
1289 * @see llvm::User::setOperand()
1290 */
Erick Tryzelaarb4d48702010-08-20 14:51:22 +00001291void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001292
1293/**
1294 * Obtain the number of operands in a llvm::User value.
1295 *
1296 * @see llvm::User::getNumOperands()
1297 */
Erick Tryzelaarb4d48702010-08-20 14:51:22 +00001298int LLVMGetNumOperands(LLVMValueRef Val);
Chris Lattner40cf28d2009-10-12 04:01:02 +00001299
Gregory Szorc34c863a2012-03-21 03:54:29 +00001300/**
1301 * @}
1302 */
1303
1304/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001305 * @defgroup LLVMCCoreValueConstant Constants
Gregory Szorc34c863a2012-03-21 03:54:29 +00001306 *
1307 * This section contains APIs for interacting with LLVMValueRef that
1308 * correspond to llvm::Constant instances.
1309 *
1310 * These functions will work for any LLVMValueRef in the llvm::Constant
1311 * class hierarchy.
1312 *
1313 * @{
1314 */
1315
1316/**
1317 * Obtain a constant value referring to the null instance of a type.
1318 *
1319 * @see llvm::Constant::getNullValue()
1320 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001321LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
Gregory Szorc34c863a2012-03-21 03:54:29 +00001322
1323/**
1324 * Obtain a constant value referring to the instance of a type
1325 * consisting of all ones.
1326 *
1327 * This is only valid for integer types.
1328 *
1329 * @see llvm::Constant::getAllOnesValue()
1330 */
1331LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1332
1333/**
1334 * Obtain a constant value referring to an undefined value of a type.
1335 *
1336 * @see llvm::UndefValue::get()
1337 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001338LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001339
1340/**
1341 * Determine whether a value instance is null.
1342 *
1343 * @see llvm::Constant::isNullValue()
1344 */
Chris Lattner25963c62010-01-09 22:27:07 +00001345LLVMBool LLVMIsNull(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001346
1347/**
1348 * Obtain a constant that is a constant pointer pointing to NULL for a
1349 * specified type.
1350 */
Chris Lattner7f318242009-07-06 17:29:59 +00001351LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001352
Gregory Szorc34c863a2012-03-21 03:54:29 +00001353/**
1354 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1355 *
1356 * Functions in this group model LLVMValueRef instances that correspond
1357 * to constants referring to scalar types.
1358 *
1359 * For integer types, the LLVMTypeRef parameter should correspond to a
1360 * llvm::IntegerType instance and the returned LLVMValueRef will
1361 * correspond to a llvm::ConstantInt.
1362 *
1363 * For floating point types, the LLVMTypeRef returned corresponds to a
1364 * llvm::ConstantFP.
1365 *
1366 * @{
1367 */
Erick Tryzelaard8531fa2010-02-28 09:45:59 +00001368
Gregory Szorc34c863a2012-03-21 03:54:29 +00001369/**
1370 * Obtain a constant value for an integer type.
1371 *
1372 * The returned value corresponds to a llvm::ConstantInt.
1373 *
1374 * @see llvm::ConstantInt::get()
1375 *
1376 * @param IntTy Integer type to obtain value of.
1377 * @param N The value the returned instance should refer to.
1378 * @param SignExtend Whether to sign extend the produced value.
1379 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001380LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
Chris Lattner25963c62010-01-09 22:27:07 +00001381 LLVMBool SignExtend);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001382
1383/**
1384 * Obtain a constant value for an integer of arbitrary precision.
1385 *
1386 * @see llvm::ConstantInt::get()
1387 */
Chris Lattner4329e072010-11-23 02:47:22 +00001388LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1389 unsigned NumWords,
1390 const uint64_t Words[]);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001391
1392/**
1393 * Obtain a constant value for an integer parsed from a string.
1394 *
1395 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1396 * string's length is available, it is preferred to call that function
1397 * instead.
1398 *
1399 * @see llvm::ConstantInt::get()
1400 */
Erick Tryzelaardd991352009-08-16 23:36:46 +00001401LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1402 uint8_t Radix);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001403
1404/**
1405 * Obtain a constant value for an integer parsed from a string with
1406 * specified length.
1407 *
1408 * @see llvm::ConstantInt::get()
1409 */
Erick Tryzelaardd991352009-08-16 23:36:46 +00001410LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1411 unsigned SLen, uint8_t Radix);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001412
1413/**
1414 * Obtain a constant value referring to a double floating point value.
1415 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001416LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001417
1418/**
1419 * Obtain a constant for a floating point value parsed from a string.
1420 *
1421 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1422 * should be used if the input string's length is known.
1423 */
Gordon Henriksen931e1212008-02-02 01:07:50 +00001424LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001425
1426/**
1427 * Obtain a constant for a floating point value parsed from a string.
1428 */
Erick Tryzelaardd991352009-08-16 23:36:46 +00001429LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1430 unsigned SLen);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001431
1432/**
1433 * Obtain the zero extended value for an integer constant value.
1434 *
1435 * @see llvm::ConstantInt::getZExtValue()
1436 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001437unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001438
1439/**
1440 * Obtain the sign extended value for an integer constant value.
1441 *
1442 * @see llvm::ConstantInt::getSExtValue()
1443 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001444long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
Erick Tryzelaardd991352009-08-16 23:36:46 +00001445
Gregory Szorc34c863a2012-03-21 03:54:29 +00001446/**
1447 * @}
1448 */
1449
1450/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001451 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1452 *
1453 * Functions in this group operate on composite constants.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001454 *
1455 * @{
1456 */
1457
1458/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001459 * Create a ConstantDataSequential and initialize it with a string.
Gregory Szorc34c863a2012-03-21 03:54:29 +00001460 *
Gregory Szorc52d26602012-03-21 07:28:27 +00001461 * @see llvm::ConstantDataArray::getString()
Gregory Szorc34c863a2012-03-21 03:54:29 +00001462 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001463LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
Chris Lattner25963c62010-01-09 22:27:07 +00001464 unsigned Length, LLVMBool DontNullTerminate);
Gregory Szorc52d26602012-03-21 07:28:27 +00001465
1466/**
1467 * Create a ConstantDataSequential with string content in the global context.
1468 *
1469 * This is the same as LLVMConstStringInContext except it operates on the
1470 * global context.
1471 *
1472 * @see LLVMConstStringInContext()
1473 * @see llvm::ConstantDataArray::getString()
1474 */
1475LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1476 LLVMBool DontNullTerminate);
1477
1478/**
1479 * Create an anonymous ConstantStruct with the specified values.
1480 *
1481 * @see llvm::ConstantStruct::getAnon()
1482 */
1483LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001484 LLVMValueRef *ConstantVals,
Chris Lattner25963c62010-01-09 22:27:07 +00001485 unsigned Count, LLVMBool Packed);
Erick Tryzelaar262332f2009-08-14 00:01:31 +00001486
Gregory Szorc52d26602012-03-21 07:28:27 +00001487/**
1488 * Create a ConstantStruct in the global Context.
1489 *
1490 * This is the same as LLVMConstStructInContext except it operates on the
1491 * global Context.
1492 *
1493 * @see LLVMConstStructInContext()
1494 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001495LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
Chris Lattner25963c62010-01-09 22:27:07 +00001496 LLVMBool Packed);
Gregory Szorc52d26602012-03-21 07:28:27 +00001497
1498/**
1499 * Create a ConstantArray from values.
1500 *
1501 * @see llvm::ConstantArray::get()
1502 */
1503LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1504 LLVMValueRef *ConstantVals, unsigned Length);
1505
1506/**
1507 * Create a non-anonymous ConstantStruct from values.
1508 *
1509 * @see llvm::ConstantStruct::get()
1510 */
Rafael Espindola784ad242011-07-14 19:09:08 +00001511LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1512 LLVMValueRef *ConstantVals,
1513 unsigned Count);
Gregory Szorc52d26602012-03-21 07:28:27 +00001514
1515/**
1516 * Create a ConstantVector from values.
1517 *
1518 * @see llvm::ConstantVector::get()
1519 */
Gordon Henriksen1046c732007-10-06 15:11:06 +00001520LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001521
Gregory Szorc52d26602012-03-21 07:28:27 +00001522/**
1523 * @}
1524 */
1525
1526/**
1527 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1528 *
1529 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1530 *
1531 * @see llvm::ConstantExpr.
1532 *
1533 * @{
1534 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001535LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +00001536LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001537LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1538LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001539LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1540LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001541LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001542LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1543LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +00001544LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001545LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001546LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001547LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001548LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1549LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001550LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001551LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00001552LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1553LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001554LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001555LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1556LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Dan Gohmane4ca02d2009-09-03 23:34:49 +00001557LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001558LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1559LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1560LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1561LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1562LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1563LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1564LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1565LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1566 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1567LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1568 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1569LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1570LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1571LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1572LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1573 LLVMValueRef *ConstantIndices, unsigned NumIndices);
Dan Gohmane4ca02d2009-09-03 23:34:49 +00001574LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1575 LLVMValueRef *ConstantIndices,
1576 unsigned NumIndices);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001577LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1578LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1579LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1580LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1581LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1582LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1583LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1584LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1585LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1586LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1587LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1588LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001589LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1590 LLVMTypeRef ToType);
1591LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1592 LLVMTypeRef ToType);
1593LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1594 LLVMTypeRef ToType);
1595LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1596 LLVMTypeRef ToType);
1597LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
Chris Lattner25963c62010-01-09 22:27:07 +00001598 LLVMBool isSigned);
Erick Tryzelaar4cc690c2009-08-16 02:20:12 +00001599LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001600LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1601 LLVMValueRef ConstantIfTrue,
1602 LLVMValueRef ConstantIfFalse);
1603LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1604 LLVMValueRef IndexConstant);
1605LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1606 LLVMValueRef ElementValueConstant,
1607 LLVMValueRef IndexConstant);
1608LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1609 LLVMValueRef VectorBConstant,
1610 LLVMValueRef MaskConstant);
Dan Gohmand5104a52008-11-03 22:55:43 +00001611LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1612 unsigned NumIdx);
1613LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1614 LLVMValueRef ElementValueConstant,
1615 unsigned *IdxList, unsigned NumIdx);
Chris Lattner25963c62010-01-09 22:27:07 +00001616LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
Chris Lattner3d1f5522008-12-17 21:39:50 +00001617 const char *AsmString, const char *Constraints,
Chris Lattner25963c62010-01-09 22:27:07 +00001618 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +00001619LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
Gordon Henriksen7ce31762007-10-06 14:29:36 +00001620
Gregory Szorc52d26602012-03-21 07:28:27 +00001621/**
1622 * @}
1623 */
1624
1625/**
1626 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1627 *
1628 * This group contains functions that operate on global values. Functions in
1629 * this group relate to functions in the llvm::GlobalValue class tree.
1630 *
1631 * @see llvm::GlobalValue
1632 *
1633 * @{
1634 */
1635
Gordon Henriksen265f7802008-03-19 01:11:35 +00001636LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
Chris Lattner25963c62010-01-09 22:27:07 +00001637LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001638LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1639void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1640const char *LLVMGetSection(LLVMValueRef Global);
1641void LLVMSetSection(LLVMValueRef Global, const char *Section);
1642LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1643void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1644unsigned LLVMGetAlignment(LLVMValueRef Global);
1645void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
1646
Gregory Szorc52d26602012-03-21 07:28:27 +00001647/**
1648 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1649 *
1650 * This group contains functions that operate on global variable values.
1651 *
1652 * @see llvm::GlobalVariable
1653 *
1654 * @{
1655 */
Gordon Henriksen76a03742007-09-18 03:18:57 +00001656LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
Erick Tryzelaar06894b32010-02-28 09:46:13 +00001657LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1658 const char *Name,
1659 unsigned AddressSpace);
Gordon Henriksen783f7bb2007-10-08 03:45:09 +00001660LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001661LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1662LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1663LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1664LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001665void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001666LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1667void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
Chris Lattner25963c62010-01-09 22:27:07 +00001668LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1669void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1670LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1671void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
Hans Wennborg5ff71202013-04-16 08:58:59 +00001672LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1673void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1674LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1675void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
Gordon Henriksen76a03742007-09-18 03:18:57 +00001676
Gregory Szorc52d26602012-03-21 07:28:27 +00001677/**
1678 * @}
1679 */
1680
1681/**
1682 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1683 *
1684 * This group contains function that operate on global alias values.
1685 *
1686 * @see llvm::GlobalAlias
1687 *
1688 * @{
1689 */
Chris Lattner3d1f5522008-12-17 21:39:50 +00001690LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1691 const char *Name);
1692
Gregory Szorc34c863a2012-03-21 03:54:29 +00001693/**
1694 * @}
1695 */
1696
1697/**
1698 * @defgroup LLVMCCoreValueFunction Function values
1699 *
1700 * Functions in this group operate on LLVMValueRef instances that
1701 * correspond to llvm::Function instances.
1702 *
1703 * @see llvm::Function
1704 *
1705 * @{
1706 */
1707
1708/**
1709 * Remove a function from its containing module and deletes it.
1710 *
1711 * @see llvm::Function::eraseFromParent()
1712 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001713void LLVMDeleteFunction(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001714
1715/**
1716 * Obtain the ID number from a function instance.
1717 *
1718 * @see llvm::Function::getIntrinsicID()
1719 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001720unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001721
1722/**
1723 * Obtain the calling function of a function.
1724 *
1725 * The returned value corresponds to the LLVMCallConv enumeration.
1726 *
1727 * @see llvm::Function::getCallingConv()
1728 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001729unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001730
1731/**
1732 * Set the calling convention of a function.
1733 *
1734 * @see llvm::Function::setCallingConv()
1735 *
1736 * @param Fn Function to operate on
1737 * @param CC LLVMCallConv to set calling convention to
1738 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001739void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001740
1741/**
1742 * Obtain the name of the garbage collector to use during code
1743 * generation.
1744 *
1745 * @see llvm::Function::getGC()
1746 */
Gordon Henriksend930f912008-08-17 18:44:35 +00001747const char *LLVMGetGC(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001748
1749/**
1750 * Define the garbage collector to use during code generation.
1751 *
1752 * @see llvm::Function::setGC()
1753 */
Gordon Henriksend930f912008-08-17 18:44:35 +00001754void LLVMSetGC(LLVMValueRef Fn, const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001755
1756/**
1757 * Add an attribute to a function.
1758 *
1759 * @see llvm::Function::addAttribute()
1760 */
Duncan Sands7374a012009-05-06 12:21:17 +00001761void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001762
1763/**
Tom Stellarde8f35e12013-04-16 23:12:43 +00001764 * Add a target-dependent attribute to a fuction
1765 * @see llvm::AttrBuilder::addAttribute()
1766 */
1767void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1768 const char *V);
1769
1770/**
Gregory Szorc34c863a2012-03-21 03:54:29 +00001771 * Obtain an attribute from a function.
1772 *
1773 * @see llvm::Function::getAttributes()
1774 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001775LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001776
1777/**
1778 * Remove an attribute from a function.
1779 */
Duncan Sands7374a012009-05-06 12:21:17 +00001780void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00001781
Gregory Szorc34c863a2012-03-21 03:54:29 +00001782/**
1783 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1784 *
1785 * Functions in this group relate to arguments/parameters on functions.
1786 *
1787 * Functions in this group expect LLVMValueRef instances that correspond
1788 * to llvm::Function instances.
1789 *
1790 * @{
1791 */
1792
1793/**
1794 * Obtain the number of parameters in a function.
1795 *
1796 * @see llvm::Function::arg_size()
1797 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001798unsigned LLVMCountParams(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001799
1800/**
1801 * Obtain the parameters in a function.
1802 *
1803 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1804 * at least LLVMCountParams() long. This array will be filled with
1805 * LLVMValueRef instances which correspond to the parameters the
1806 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1807 * instance.
1808 *
1809 * @see llvm::Function::arg_begin()
1810 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001811void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001812
1813/**
1814 * Obtain the parameter at the specified index.
1815 *
1816 * Parameters are indexed from 0.
1817 *
1818 * @see llvm::Function::arg_begin()
1819 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001820LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001821
1822/**
1823 * Obtain the function to which this argument belongs.
1824 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001825 * Unlike other functions in this group, this one takes an LLVMValueRef
Gregory Szorc34c863a2012-03-21 03:54:29 +00001826 * that corresponds to a llvm::Attribute.
1827 *
1828 * The returned LLVMValueRef is the llvm::Function to which this
1829 * argument belongs.
1830 */
Gordon Henriksen265f7802008-03-19 01:11:35 +00001831LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001832
1833/**
1834 * Obtain the first parameter to a function.
1835 *
1836 * @see llvm::Function::arg_begin()
1837 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001838LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001839
1840/**
1841 * Obtain the last parameter to a function.
1842 *
1843 * @see llvm::Function::arg_end()
1844 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001845LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001846
1847/**
1848 * Obtain the next parameter to a function.
1849 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001850 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
Gregory Szorc34c863a2012-03-21 03:54:29 +00001851 * actually a wrapped iterator) and obtains the next parameter from the
1852 * underlying iterator.
1853 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001854LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001855
1856/**
1857 * Obtain the previous parameter to a function.
1858 *
1859 * This is the opposite of LLVMGetNextParam().
1860 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001861LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001862
1863/**
1864 * Add an attribute to a function argument.
1865 *
1866 * @see llvm::Argument::addAttr()
1867 */
Devang Patel4c758ea2008-09-25 21:00:45 +00001868void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001869
1870/**
1871 * Remove an attribute from a function argument.
1872 *
1873 * @see llvm::Argument::removeAttr()
1874 */
Devang Patel4c758ea2008-09-25 21:00:45 +00001875void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001876
1877/**
1878 * Get an attribute from a function argument.
1879 */
Chris Lattner40cf28d2009-10-12 04:01:02 +00001880LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001881
1882/**
1883 * Set the alignment for a function parameter.
1884 *
1885 * @see llvm::Argument::addAttr()
Bill Wendling50d27842012-10-15 20:35:56 +00001886 * @see llvm::AttrBuilder::addAlignmentAttr()
Gregory Szorc34c863a2012-03-21 03:54:29 +00001887 */
Gordon Henriksen2d9cc212008-04-28 17:37:06 +00001888void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
Gordon Henriksen265f7802008-03-19 01:11:35 +00001889
Gregory Szorc34c863a2012-03-21 03:54:29 +00001890/**
1891 * @}
1892 */
1893
1894/**
1895 * @}
1896 */
1897
1898/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001899 * @}
1900 */
1901
1902/**
1903 * @}
1904 */
1905
1906/**
1907 * @defgroup LLVMCCoreValueMetadata Metadata
1908 *
1909 * @{
1910 */
1911
1912/**
1913 * Obtain a MDString value from a context.
1914 *
1915 * The returned instance corresponds to the llvm::MDString class.
1916 *
1917 * The instance is specified by string data of a specified length. The
1918 * string content is copied, so the backing memory can be freed after
1919 * this function returns.
1920 */
1921LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
1922 unsigned SLen);
1923
1924/**
1925 * Obtain a MDString value from the global context.
1926 */
1927LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
1928
1929/**
1930 * Obtain a MDNode value from a context.
1931 *
1932 * The returned value corresponds to the llvm::MDNode class.
1933 */
1934LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
1935 unsigned Count);
1936
1937/**
1938 * Obtain a MDNode value from the global context.
1939 */
1940LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
1941
1942/**
1943 * Obtain the underlying string from a MDString value.
1944 *
1945 * @param V Instance to obtain string from.
1946 * @param Len Memory address which will hold length of returned string.
1947 * @return String data in MDString.
1948 */
1949const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
1950
1951/**
Duncan Sands12ccbe72012-09-19 20:29:39 +00001952 * Obtain the number of operands from an MDNode value.
1953 *
1954 * @param V MDNode to get number of operands from.
1955 * @return Number of operands of the MDNode.
1956 */
1957unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
1958
1959/**
1960 * Obtain the given MDNode's operands.
1961 *
1962 * The passed LLVMValueRef pointer should point to enough memory to hold all of
1963 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
1964 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
1965 * MDNode's operands.
1966 *
1967 * @param V MDNode to get the operands from.
1968 * @param Dest Destination array for operands.
1969 */
1970void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
1971
1972/**
Gregory Szorc52d26602012-03-21 07:28:27 +00001973 * @}
1974 */
1975
1976/**
Gregory Szorc34c863a2012-03-21 03:54:29 +00001977 * @defgroup LLVMCCoreValueBasicBlock Basic Block
1978 *
1979 * A basic block represents a single entry single exit section of code.
1980 * Basic blocks contain a list of instructions which form the body of
1981 * the block.
1982 *
1983 * Basic blocks belong to functions. They have the type of label.
1984 *
1985 * Basic blocks are themselves values. However, the C API models them as
1986 * LLVMBasicBlockRef.
1987 *
1988 * @see llvm::BasicBlock
1989 *
1990 * @{
1991 */
1992
1993/**
1994 * Convert a basic block instance to a value type.
1995 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00001996LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00001997
1998/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00001999 * Determine whether an LLVMValueRef is itself a basic block.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002000 */
Chris Lattner25963c62010-01-09 22:27:07 +00002001LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002002
2003/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002004 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002005 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002006LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002007
2008/**
2009 * Obtain the function to which a basic block belongs.
2010 *
2011 * @see llvm::BasicBlock::getParent()
2012 */
Gordon Henriksen07a45f42008-03-23 22:21:29 +00002013LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002014
2015/**
2016 * Obtain the terminator instruction for a basic block.
2017 *
2018 * If the basic block does not have a terminator (it is not well-formed
2019 * if it doesn't), then NULL is returned.
2020 *
2021 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2022 *
2023 * @see llvm::BasicBlock::getTerminator()
2024 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002025LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002026
2027/**
2028 * Obtain the number of basic blocks in a function.
2029 *
2030 * @param Fn Function value to operate on.
2031 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002032unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002033
2034/**
2035 * Obtain all of the basic blocks in a function.
2036 *
2037 * This operates on a function value. The BasicBlocks parameter is a
2038 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2039 * LLVMCountBasicBlocks() in length. This array is populated with
2040 * LLVMBasicBlockRef instances.
2041 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002042void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002043
2044/**
2045 * Obtain the first basic block in a function.
2046 *
2047 * The returned basic block can be used as an iterator. You will likely
2048 * eventually call into LLVMGetNextBasicBlock() with it.
2049 *
2050 * @see llvm::Function::begin()
2051 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002052LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002053
2054/**
2055 * Obtain the last basic block in a function.
2056 *
2057 * @see llvm::Function::end()
2058 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002059LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002060
2061/**
2062 * Advance a basic block iterator.
2063 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002064LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002065
2066/**
2067 * Go backwards in a basic block iterator.
2068 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002069LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002070
2071/**
2072 * Obtain the basic block that corresponds to the entry point of a
2073 * function.
2074 *
2075 * @see llvm::Function::getEntryBlock()
2076 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002077LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002078
Gregory Szorc34c863a2012-03-21 03:54:29 +00002079/**
2080 * Append a basic block to the end of a function.
2081 *
2082 * @see llvm::BasicBlock::Create()
2083 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002084LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2085 LLVMValueRef Fn,
2086 const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002087
2088/**
2089 * Append a basic block to the end of a function using the global
2090 * context.
2091 *
2092 * @see llvm::BasicBlock::Create()
2093 */
2094LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2095
2096/**
2097 * Insert a basic block in a function before another basic block.
2098 *
2099 * The function to add to is determined by the function of the
2100 * passed basic block.
2101 *
2102 * @see llvm::BasicBlock::Create()
2103 */
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002104LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2105 LLVMBasicBlockRef BB,
2106 const char *Name);
2107
Gregory Szorc34c863a2012-03-21 03:54:29 +00002108/**
2109 * Insert a basic block in a function using the global context.
2110 *
2111 * @see llvm::BasicBlock::Create()
2112 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002113LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2114 const char *Name);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002115
2116/**
2117 * Remove a basic block from a function and delete it.
2118 *
2119 * This deletes the basic block from its containing function and deletes
2120 * the basic block itself.
2121 *
2122 * @see llvm::BasicBlock::eraseFromParent()
2123 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002124void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002125
2126/**
2127 * Remove a basic block from a function.
2128 *
2129 * This deletes the basic block from its containing function but keep
2130 * the basic block alive.
2131 *
2132 * @see llvm::BasicBlock::removeFromParent()
2133 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002134void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002135
Gregory Szorc34c863a2012-03-21 03:54:29 +00002136/**
2137 * Move a basic block to before another one.
2138 *
2139 * @see llvm::BasicBlock::moveBefore()
2140 */
Duncan Sandsb1d61aa2010-07-19 15:31:07 +00002141void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002142
2143/**
2144 * Move a basic block to after another one.
2145 *
2146 * @see llvm::BasicBlock::moveAfter()
2147 */
Duncan Sandsb1d61aa2010-07-19 15:31:07 +00002148void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2149
Gregory Szorc34c863a2012-03-21 03:54:29 +00002150/**
2151 * Obtain the first instruction in a basic block.
2152 *
2153 * The returned LLVMValueRef corresponds to a llvm::Instruction
2154 * instance.
2155 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002156LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002157
2158/**
2159 * Obtain the last instruction in a basic block.
2160 *
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002161 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002162 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002163LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
Nate Begeman43c322b2011-08-23 20:27:46 +00002164
Gregory Szorc34c863a2012-03-21 03:54:29 +00002165/**
2166 * @}
2167 */
2168
2169/**
2170 * @defgroup LLVMCCoreValueInstruction Instructions
2171 *
2172 * Functions in this group relate to the inspection and manipulation of
2173 * individual instructions.
2174 *
2175 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2176 * class has a large number of descendents. llvm::Instruction is a
2177 * llvm::Value and in the C API, instructions are modeled by
2178 * LLVMValueRef.
2179 *
2180 * This group also contains sub-groups which operate on specific
2181 * llvm::Instruction types, e.g. llvm::CallInst.
2182 *
2183 * @{
2184 */
2185
2186/**
2187 * Determine whether an instruction has any metadata attached.
2188 */
2189int LLVMHasMetadata(LLVMValueRef Val);
2190
2191/**
2192 * Return metadata associated with an instruction value.
2193 */
2194LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2195
2196/**
2197 * Set metadata associated with an instruction value.
2198 */
2199void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2200
2201/**
2202 * Obtain the basic block to which an instruction belongs.
2203 *
2204 * @see llvm::Instruction::getParent()
2205 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002206LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002207
2208/**
2209 * Obtain the instruction that occurs after the one specified.
2210 *
2211 * The next instruction will be from the same basic block.
2212 *
2213 * If this is the last instruction in a basic block, NULL will be
2214 * returned.
2215 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002216LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002217
2218/**
Benjamin Kramerbde91762012-06-02 10:20:22 +00002219 * Obtain the instruction that occurred before this one.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002220 *
2221 * If the instruction is the first instruction in a basic block, NULL
2222 * will be returned.
2223 */
Gordon Henriksen054817c2008-03-19 03:47:18 +00002224LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002225
2226/**
2227 * Remove and delete an instruction.
2228 *
2229 * The instruction specified is removed from its containing building
2230 * block and then deleted.
2231 *
2232 * @see llvm::Instruction::eraseFromParent()
2233 */
Devang Pateldbebc6f2011-10-03 20:59:18 +00002234void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002235
2236/**
2237 * Obtain the code opcode for an individual instruction.
2238 *
2239 * @see llvm::Instruction::getOpCode()
2240 */
Torok Edwinab6158e2011-10-14 20:37:49 +00002241LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002242
2243/**
2244 * Obtain the predicate of an instruction.
2245 *
2246 * This is only valid for instructions that correspond to llvm::ICmpInst
2247 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2248 *
2249 * @see llvm::ICmpInst::getPredicate()
2250 */
Torok Edwin60c40de2011-10-06 12:13:20 +00002251LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
Gordon Henriksen265f7802008-03-19 01:11:35 +00002252
Gregory Szorc34c863a2012-03-21 03:54:29 +00002253/**
2254 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2255 *
2256 * Functions in this group apply to instructions that refer to call
2257 * sites and invocations. These correspond to C++ types in the
2258 * llvm::CallInst class tree.
2259 *
2260 * @{
2261 */
2262
2263/**
2264 * Set the calling convention for a call instruction.
2265 *
2266 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2267 * llvm::InvokeInst.
2268 *
2269 * @see llvm::CallInst::setCallingConv()
2270 * @see llvm::InvokeInst::setCallingConv()
2271 */
Gordon Henriksen1158c532007-12-29 20:45:00 +00002272void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002273
2274/**
2275 * Obtain the calling convention for a call instruction.
2276 *
2277 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2278 * usage.
2279 *
2280 * @see LLVMSetInstructionCallConv()
2281 */
Gordon Henriksen1158c532007-12-29 20:45:00 +00002282unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002283
2284
Devang Patel4c758ea2008-09-25 21:00:45 +00002285void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002286void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
Devang Patel4c758ea2008-09-25 21:00:45 +00002287 LLVMAttribute);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002288void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
Gordon Henriksen2d9cc212008-04-28 17:37:06 +00002289 unsigned align);
Gordon Henriksen1158c532007-12-29 20:45:00 +00002290
Gregory Szorc34c863a2012-03-21 03:54:29 +00002291/**
2292 * Obtain whether a call instruction is a tail call.
2293 *
2294 * This only works on llvm::CallInst instructions.
2295 *
2296 * @see llvm::CallInst::isTailCall()
2297 */
Chris Lattner25963c62010-01-09 22:27:07 +00002298LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002299
2300/**
2301 * Set whether a call instruction is a tail call.
2302 *
2303 * This only works on llvm::CallInst instructions.
2304 *
2305 * @see llvm::CallInst::setTailCall()
2306 */
Chris Lattner25963c62010-01-09 22:27:07 +00002307void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
Gordon Henrikseneeb65372008-08-30 16:34:54 +00002308
Gregory Szorc34c863a2012-03-21 03:54:29 +00002309/**
2310 * @}
2311 */
2312
2313/**
2314 * Obtain the default destination basic block of a switch instruction.
2315 *
2316 * This only works on llvm::SwitchInst instructions.
2317 *
2318 * @see llvm::SwitchInst::getDefaultDest()
2319 */
Nate Begeman43c322b2011-08-23 20:27:46 +00002320LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2321
Gregory Szorc34c863a2012-03-21 03:54:29 +00002322/**
2323 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2324 *
2325 * Functions in this group only apply to instructions that map to
2326 * llvm::PHINode instances.
2327 *
2328 * @{
2329 */
2330
2331/**
2332 * Add an incoming value to the end of a PHI list.
2333 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002334void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2335 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002336
2337/**
2338 * Obtain the number of incoming basic blocks to a PHI node.
2339 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002340unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002341
2342/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002343 * Obtain an incoming value to a PHI node as an LLVMValueRef.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002344 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002345LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
Gregory Szorc34c863a2012-03-21 03:54:29 +00002346
2347/**
Daniel Dunbar06b9f9e2013-08-16 23:30:19 +00002348 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002349 */
Gordon Henriksen44dd8fb2007-10-08 18:14:39 +00002350LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002351
Gregory Szorc34c863a2012-03-21 03:54:29 +00002352/**
2353 * @}
2354 */
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002355
Gregory Szorc34c863a2012-03-21 03:54:29 +00002356/**
2357 * @}
2358 */
2359
2360/**
2361 * @}
2362 */
2363
2364/**
2365 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2366 *
2367 * An instruction builder represents a point within a basic block and is
2368 * the exclusive means of building instructions using the C interface.
2369 *
2370 * @{
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002371 */
2372
Erick Tryzelaar262332f2009-08-14 00:01:31 +00002373LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
Gordon Henriksena735a9c2008-05-04 12:55:34 +00002374LLVMBuilderRef LLVMCreateBuilder(void);
Gordon Henriksen054817c2008-03-19 03:47:18 +00002375void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2376 LLVMValueRef Instr);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002377void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2378void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
Gordon Henriksen265f7802008-03-19 01:11:35 +00002379LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
Chris Lattner3d1f5522008-12-17 21:39:50 +00002380void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2381void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
Erick Tryzelaar9813bea2009-08-16 02:20:57 +00002382void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2383 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002384void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2385
Erick Tryzelaard8531fa2010-02-28 09:45:59 +00002386/* Metadata */
2387void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2388LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2389void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2390
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002391/* Terminators */
2392LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2393LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
Erick Tryzelaarfd529d72009-08-19 08:36:49 +00002394LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002395 unsigned N);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002396LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2397LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2398 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2399LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2400 LLVMBasicBlockRef Else, unsigned NumCases);
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +00002401LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2402 unsigned NumDests);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002403LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2404 LLVMValueRef *Args, unsigned NumArgs,
2405 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2406 const char *Name);
Benjamin Kramer5a6568832011-08-19 01:36:54 +00002407LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2408 LLVMValueRef PersFn, unsigned NumClauses,
2409 const char *Name);
Bill Wendlingf891bf82011-07-31 06:30:59 +00002410LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002411LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2412
Gordon Henriksen097102c2008-01-01 05:50:53 +00002413/* Add a case to the switch instruction */
2414void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2415 LLVMBasicBlockRef Dest);
2416
Erick Tryzelaar0fb26ef2010-02-28 09:46:06 +00002417/* Add a destination to the indirectbr instruction */
2418void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2419
Bill Wendlingfae14752011-08-12 20:24:12 +00002420/* Add a catch or filter clause to the landingpad instruction */
2421void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2422
2423/* Set the 'cleanup' flag in the landingpad instruction */
2424void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2425
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002426/* Arithmetic */
2427LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2428 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002429LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2430 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002431LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2432 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002433LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2434 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002435LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2436 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002437LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2438 const char *Name);
2439LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2440 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002441LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2442 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002443LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2444 const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002445LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2446 const char *Name);
2447LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2448 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002449LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2450 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002451LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2452 const char *Name);
2453LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2454 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002455LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2456 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002457LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2458 const char *Name);
2459LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2460 const char *Name);
2461LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2462 const char *Name);
2463LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2464 const char *Name);
2465LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2466 const char *Name);
2467LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2468 const char *Name);
2469LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2470 const char *Name);
2471LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2472 const char *Name);
2473LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2474 const char *Name);
2475LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2476 const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +00002477LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2478 LLVMValueRef LHS, LLVMValueRef RHS,
2479 const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002480LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Erick Tryzelaar4c340c72010-02-28 05:51:43 +00002481LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2482 const char *Name);
2483LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2484 const char *Name);
Dan Gohmanf919bd62009-09-28 21:51:41 +00002485LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002486LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2487
2488/* Memory */
2489LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2490LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2491 LLVMValueRef Val, const char *Name);
2492LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2493LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2494 LLVMValueRef Val, const char *Name);
2495LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2496LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2497 const char *Name);
2498LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2499LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2500 LLVMValueRef *Indices, unsigned NumIndices,
2501 const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002502LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2503 LLVMValueRef *Indices, unsigned NumIndices,
2504 const char *Name);
2505LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2506 unsigned Idx, const char *Name);
2507LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2508 const char *Name);
2509LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2510 const char *Name);
Chris Lattner2cc6f9d2012-03-22 03:54:15 +00002511LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2512void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002513
2514/* Casts */
2515LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2516 LLVMTypeRef DestTy, const char *Name);
2517LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2518 LLVMTypeRef DestTy, const char *Name);
2519LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2520 LLVMTypeRef DestTy, const char *Name);
2521LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2522 LLVMTypeRef DestTy, const char *Name);
2523LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2524 LLVMTypeRef DestTy, const char *Name);
2525LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2526 LLVMTypeRef DestTy, const char *Name);
2527LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2528 LLVMTypeRef DestTy, const char *Name);
2529LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2530 LLVMTypeRef DestTy, const char *Name);
2531LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2532 LLVMTypeRef DestTy, const char *Name);
2533LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2534 LLVMTypeRef DestTy, const char *Name);
2535LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2536 LLVMTypeRef DestTy, const char *Name);
2537LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2538 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002539LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2540 LLVMTypeRef DestTy, const char *Name);
2541LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2542 LLVMTypeRef DestTy, const char *Name);
2543LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2544 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar31831792010-02-28 05:51:27 +00002545LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2546 LLVMTypeRef DestTy, const char *Name);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002547LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2548 LLVMTypeRef DestTy, const char *Name);
Duncan Sands9d786d72009-11-23 10:49:03 +00002549LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002550 LLVMTypeRef DestTy, const char *Name);
2551LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2552 LLVMTypeRef DestTy, const char *Name);
Gordon Henriksenc23b66c2007-09-26 20:56:12 +00002553
2554/* Comparisons */
2555LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2556 LLVMValueRef LHS, LLVMValueRef RHS,
2557 const char *Name);
2558LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2559 LLVMValueRef LHS, LLVMValueRef RHS,
2560 const char *Name);
2561
2562/* Miscellaneous instructions */
2563LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2564LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2565 LLVMValueRef *Args, unsigned NumArgs,
2566 const char *Name);
2567LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2568 LLVMValueRef Then, LLVMValueRef Else,
2569 const char *Name);
2570LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2571 const char *Name);
2572LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2573 LLVMValueRef Index, const char *Name);
2574LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2575 LLVMValueRef EltVal, LLVMValueRef Index,
2576 const char *Name);
2577LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2578 LLVMValueRef V2, LLVMValueRef Mask,
2579 const char *Name);
Dan Gohmand5104a52008-11-03 22:55:43 +00002580LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2581 unsigned Index, const char *Name);
2582LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2583 LLVMValueRef EltVal, unsigned Index,
2584 const char *Name);
Gordon Henriksen76a03742007-09-18 03:18:57 +00002585
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002586LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2587 const char *Name);
2588LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2589 const char *Name);
2590LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2591 LLVMValueRef RHS, const char *Name);
Carlo Kok8c6719b2013-04-23 13:21:19 +00002592LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B,LLVMAtomicRMWBinOp op,
2593 LLVMValueRef PTR, LLVMValueRef Val,
2594 LLVMAtomicOrdering ordering,
2595 LLVMBool singleThread);
Erick Tryzelaar3045b8b2009-08-16 02:19:59 +00002596
Gregory Szorc34c863a2012-03-21 03:54:29 +00002597/**
2598 * @}
2599 */
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002600
Gregory Szorc34c863a2012-03-21 03:54:29 +00002601/**
2602 * @defgroup LLVMCCoreModuleProvider Module Providers
2603 *
2604 * @{
2605 */
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002606
Gregory Szorc34c863a2012-03-21 03:54:29 +00002607/**
2608 * Changes the type of M so it can be passed to FunctionPassManagers and the
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002609 * JIT. They take ModuleProviders for historical reasons.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002610 */
2611LLVMModuleProviderRef
2612LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2613
Gregory Szorc34c863a2012-03-21 03:54:29 +00002614/**
2615 * Destroys the module M.
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002616 */
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002617void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
Gordon Henriksen0a68fe22007-12-12 01:04:30 +00002618
Gregory Szorc34c863a2012-03-21 03:54:29 +00002619/**
2620 * @}
2621 */
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002622
Gregory Szorc34c863a2012-03-21 03:54:29 +00002623/**
2624 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2625 *
2626 * @{
2627 */
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002628
Chris Lattner25963c62010-01-09 22:27:07 +00002629LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2630 LLVMMemoryBufferRef *OutMemBuf,
2631 char **OutMessage);
2632LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2633 char **OutMessage);
Bill Wendling526276a2013-02-14 19:11:28 +00002634LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2635 size_t InputDataLength,
2636 const char *BufferName,
Bill Wendlingc9baa962013-02-14 19:39:14 +00002637 LLVMBool RequiresNullTerminator);
Bill Wendling526276a2013-02-14 19:11:28 +00002638LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2639 size_t InputDataLength,
2640 const char *BufferName);
Tom Stellard62c03202013-04-18 19:50:53 +00002641const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
Tom Stellardb7fb7242013-04-16 23:12:51 +00002642size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
Gordon Henriksen34eb6d82007-12-19 22:30:40 +00002643void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2644
Gregory Szorc34c863a2012-03-21 03:54:29 +00002645/**
2646 * @}
2647 */
2648
2649/**
2650 * @defgroup LLVMCCorePassRegistry Pass Registry
2651 *
2652 * @{
2653 */
Owen Anderson4698c5d2010-10-07 17:55:47 +00002654
2655/** Return the global pass registry, for use with initialization functions.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002656 @see llvm::PassRegistry::getPassRegistry */
Owen Anderson4698c5d2010-10-07 17:55:47 +00002657LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002658
Gregory Szorc34c863a2012-03-21 03:54:29 +00002659/**
2660 * @}
2661 */
2662
2663/**
2664 * @defgroup LLVMCCorePassManagers Pass Managers
2665 *
2666 * @{
2667 */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002668
2669/** Constructs a new whole-module pass pipeline. This type of pipeline is
2670 suitable for link-time optimization and whole-module transformations.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002671 @see llvm::PassManager::PassManager */
Gordon Henriksena735a9c2008-05-04 12:55:34 +00002672LLVMPassManagerRef LLVMCreatePassManager(void);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002673
2674/** Constructs a new function-by-function pass pipeline over the module
2675 provider. It does not take ownership of the module provider. This type of
2676 pipeline is suitable for code generation and JIT compilation tasks.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002677 @see llvm::FunctionPassManager::FunctionPassManager */
Erick Tryzelaarad0e0cb2010-03-02 23:58:54 +00002678LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2679
2680/** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002681LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2682
2683/** Initializes, executes on the provided module, and finalizes all of the
2684 passes scheduled in the pass manager. Returns 1 if any of the passes
Gregory Szorc34c863a2012-03-21 03:54:29 +00002685 modified the module, 0 otherwise.
2686 @see llvm::PassManager::run(Module&) */
Chris Lattner25963c62010-01-09 22:27:07 +00002687LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002688
2689/** Initializes all of the function passes scheduled in the function pass
2690 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002691 @see llvm::FunctionPassManager::doInitialization */
Chris Lattner25963c62010-01-09 22:27:07 +00002692LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002693
2694/** Executes all of the function passes scheduled in the function pass manager
2695 on the provided function. Returns 1 if any of the passes modified the
2696 function, false otherwise.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002697 @see llvm::FunctionPassManager::run(Function&) */
Chris Lattner25963c62010-01-09 22:27:07 +00002698LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002699
2700/** Finalizes all of the function passes scheduled in in the function pass
2701 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002702 @see llvm::FunctionPassManager::doFinalization */
Chris Lattner25963c62010-01-09 22:27:07 +00002703LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
Gordon Henriksen878114b2008-03-16 04:20:44 +00002704
2705/** Frees the memory of a pass pipeline. For function pipelines, does not free
2706 the module provider.
Gregory Szorc34c863a2012-03-21 03:54:29 +00002707 @see llvm::PassManagerBase::~PassManagerBase. */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002708void LLVMDisposePassManager(LLVMPassManagerRef PM);
2709
Gregory Szorc34c863a2012-03-21 03:54:29 +00002710/**
2711 * @}
2712 */
2713
2714/**
Duncan Sands1cba0a82013-02-17 16:35:51 +00002715 * @defgroup LLVMCCoreThreading Threading
2716 *
2717 * Handle the structures needed to make LLVM safe for multithreading.
2718 *
2719 * @{
2720 */
2721
2722/** Allocate and initialize structures needed to make LLVM safe for
2723 multithreading. The return value indicates whether multithreaded
2724 initialization succeeded. Must be executed in isolation from all
2725 other LLVM api calls.
2726 @see llvm::llvm_start_multithreaded */
2727LLVMBool LLVMStartMultithreaded();
2728
2729/** Deallocate structures necessary to make LLVM safe for multithreading.
2730 Must be executed in isolation from all other LLVM api calls.
2731 @see llvm::llvm_stop_multithreaded */
2732void LLVMStopMultithreaded();
2733
2734/** Check whether LLVM is executing in thread-safe mode or not.
2735 @see llvm::llvm_is_multithreaded */
2736LLVMBool LLVMIsMultithreaded();
2737
2738/**
2739 * @}
2740 */
2741
2742/**
Gregory Szorc34c863a2012-03-21 03:54:29 +00002743 * @}
2744 */
2745
2746/**
2747 * @}
2748 */
Gordon Henriksen878114b2008-03-16 04:20:44 +00002749
Gordon Henriksen76a03742007-09-18 03:18:57 +00002750#ifdef __cplusplus
2751}
Evan Cheng2e254d02013-04-04 17:40:53 +00002752#endif /* !defined(__cplusplus) */
Gordon Henriksen7330acd2007-10-05 23:59:36 +00002753
Evan Cheng2e254d02013-04-04 17:40:53 +00002754#endif /* !defined(LLVM_C_CORE_H) */