1 /*===-- llvm-c/Core.h - Core Library C Interface ------------------*- C -*-===*\
3 |* The LLVM Compiler Infrastructure *|
5 |* This file is distributed under the University of Illinois Open Source *|
6 |* License. See LICENSE.TXT for details. *|
8 |*===----------------------------------------------------------------------===*|
10 |* This header declares the C interface to libLLVMCore.a, which implements *|
11 |* the LLVM intermediate representation. *|
13 \*===----------------------------------------------------------------------===*/
18 #include "llvm/Support/DataTypes.h"
25 * @defgroup LLVMC LLVM-C: C interface to LLVM
27 * This module exposes parts of the LLVM library as a C API.
33 * @defgroup LLVMCTransforms Transforms
37 * @defgroup LLVMCCore Core
39 * This modules provide an interface to libLLVMCore, which implements
40 * the LLVM intermediate representation as well as other related types
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.
49 * If in doubt, refer to Core.cpp, which performs parameter downcasts in the
50 * form unwrap<RequiredType>(Param).
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.
60 * @defgroup LLVMCCoreTypes Types and Enumerations
70 * The top-level container for all LLVM global data. See the LLVMContext class.
72 typedef struct LLVMOpaqueContext *LLVMContextRef;
75 * The top-level container for all other LLVM Intermediate Representation (IR)
80 typedef struct LLVMOpaqueModule *LLVMModuleRef;
83 * Each value in the LLVM IR has a type, an LLVMTypeRef.
87 typedef struct LLVMOpaqueType *LLVMTypeRef;
90 * Represents an individual value in LLVM IR.
92 * This models llvm::Value.
94 typedef struct LLVMOpaqueValue *LLVMValueRef;
97 * Represents a basic block of instructions in LLVM IR.
99 * This models llvm::BasicBlock.
101 typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
104 * Represents an LLVM basic block builder.
106 * This models llvm::IRBuilder.
108 typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
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.
115 typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
118 * Used to provide a module to JIT or interpreter.
120 * @see llvm::MemoryBuffer
122 typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
124 /** @see llvm::PassManagerBase */
125 typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
127 /** @see llvm::PassRegistry */
128 typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef;
131 * Used to get the users and usees of a Value.
134 typedef struct LLVMOpaqueUse *LLVMUseRef;
137 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,
147 LLVMReadOnlyAttribute = 1<<10,
148 LLVMNoInlineAttribute = 1<<11,
149 LLVMAlwaysInlineAttribute = 1<<12,
150 LLVMOptimizeForSizeAttribute = 1<<13,
151 LLVMStackProtectAttribute = 1<<14,
152 LLVMStackProtectReqAttribute = 1<<15,
153 LLVMAlignment = 31<<16,
154 LLVMNoCaptureAttribute = 1<<21,
155 LLVMNoRedZoneAttribute = 1<<22,
156 LLVMNoImplicitFloatAttribute = 1<<23,
157 LLVMNakedAttribute = 1<<24,
158 LLVMInlineHintAttribute = 1<<25,
159 LLVMStackAlignment = 7<<26,
160 LLVMReturnsTwice = 1 << 29,
161 LLVMUWTable = 1 << 30,
162 LLVMNonLazyBind = 1 << 31
164 /* FIXME: These attributes are currently not included in the C API as
165 a temporary measure until the API/ABI impact to the C API is understood
166 and the path forward agreed upon.
167 LLVMAddressSafety = 1ULL << 32,
168 LLVMStackProtectStrongAttribute = 1ULL<<33,
169 LLVMCold = 1ULL << 34,
170 LLVMOptimizeNone = 1ULL << 35
175 /* Terminator Instructions */
181 /* removed 6 due to API changes */
184 /* Standard Binary Operators */
198 /* Logical Operators */
206 /* Memory Operators */
210 LLVMGetElementPtr = 29,
226 /* Other Operators */
235 LLVMExtractElement = 50,
236 LLVMInsertElement = 51,
237 LLVMShuffleVector = 52,
238 LLVMExtractValue = 53,
239 LLVMInsertValue = 54,
241 /* Atomic operators */
243 LLVMAtomicCmpXchg = 56,
246 /* Exception Handling Operators */
253 LLVMVoidTypeKind, /**< type with no size */
254 LLVMHalfTypeKind, /**< 16 bit floating point type */
255 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 */
266 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
267 LLVMMetadataTypeKind, /**< Metadata */
268 LLVMX86_MMXTypeKind /**< X86 MMX */
272 LLVMExternalLinkage, /**< Externally visible function */
273 LLVMAvailableExternallyLinkage,
274 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
275 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
277 LLVMLinkOnceODRAutoHideLinkage, /**< Obsolete */
278 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
279 LLVMWeakODRLinkage, /**< Same, but only replaced by something
281 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
282 LLVMInternalLinkage, /**< Rename collisions when linking (static
284 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
285 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
286 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
287 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
288 LLVMGhostLinkage, /**< Obsolete */
289 LLVMCommonLinkage, /**< Tentative definitions */
290 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
291 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
295 LLVMDefaultVisibility, /**< The GV is visible */
296 LLVMHiddenVisibility, /**< The GV is hidden */
297 LLVMProtectedVisibility /**< The GV is protected */
302 LLVMFastCallConv = 8,
303 LLVMColdCallConv = 9,
304 LLVMX86StdcallCallConv = 64,
305 LLVMX86FastcallCallConv = 65
309 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 */
322 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) */
341 LLVMLandingPadCatch, /**< A catch clause */
342 LLVMLandingPadFilter /**< A filter clause */
343 } LLVMLandingPadClauseTy;
346 LLVMNotThreadLocal = 0,
347 LLVMGeneralDynamicTLSModel,
348 LLVMLocalDynamicTLSModel,
349 LLVMInitialExecTLSModel,
350 LLVMLocalExecTLSModel
351 } LLVMThreadLocalMode;
354 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
366 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
367 Release barrier (for fences and
368 operations which both read and write
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
376 SequentiallyConsistent
378 } LLVMAtomicOrdering;
381 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
391 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
392 original using a signed comparison and return
394 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
395 original using an unsigned comparison and return
397 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
398 original using an unsigned comparison and return
400 } LLVMAtomicRMWBinOp;
406 void LLVMInitializeCore(LLVMPassRegistryRef R);
408 /** Deallocate and destroy all ManagedStatic variables.
409 @see llvm::llvm_shutdown
410 @see ManagedStatic */
411 void LLVMShutdown(void);
414 /*===-- Error handling ----------------------------------------------------===*/
416 char *LLVMCreateMessage(const char *Message);
417 void LLVMDisposeMessage(char *Message);
419 typedef void (*LLVMFatalErrorHandler)(const char *Reason);
422 * Install a fatal error handler. By default, if LLVM detects a fatal error, it
423 * will call exit(1). This may not be appropriate in many contexts. For example,
424 * doing exit(1) will bypass many crash reporting/tracing system tools. This
425 * function allows you to install a callback that will be invoked prior to the
428 void LLVMInstallFatalErrorHandler(LLVMFatalErrorHandler Handler);
431 * Reset the fatal error handler. This resets LLVM's fatal error handling
432 * behavior to the default.
434 void LLVMResetFatalErrorHandler(void);
437 * Disable LLVM's built-in stack trace code. This must be called before any
438 * other LLVM APIs; otherwise the results are undefined.
440 * FIXME: This API should be replaced by a LLVMEnablePrettyStackTrace()
441 * function; the default should be that pretty stack traces are disabled.
443 void LLVMDisablePrettyStackTrace(void);
446 * @defgroup LLVMCCoreContext Contexts
448 * Contexts are execution states for the core LLVM IR system.
450 * Most types are tied to a context instance. Multiple contexts can
451 * exist simultaneously. A single context is not thread safe. However,
452 * different contexts can execute on different threads simultaneously.
458 * Create a new context.
460 * Every call to this function should be paired with a call to
461 * LLVMContextDispose() or the context will leak memory.
463 LLVMContextRef LLVMContextCreate(void);
466 * Obtain the global context instance.
468 LLVMContextRef LLVMGetGlobalContext(void);
471 * Destroy a context instance.
473 * This should be called for every call to LLVMContextCreate() or memory
476 void LLVMContextDispose(LLVMContextRef C);
478 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
480 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
487 * @defgroup LLVMCCoreModule Modules
489 * Modules represent the top-level structure in an LLVM program. An LLVM
490 * module is effectively a translation unit or a collection of
491 * translation units merged together.
497 * Create a new, empty module in the global context.
499 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
500 * LLVMGetGlobalContext() as the context parameter.
502 * Every invocation should be paired with LLVMDisposeModule() or memory
505 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
508 * Create a new, empty module in a specific context.
510 * Every invocation should be paired with LLVMDisposeModule() or memory
513 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
517 * Destroy a module instance.
519 * This must be called for every created module or memory will be
522 void LLVMDisposeModule(LLVMModuleRef M);
525 * Obtain the data layout for a module.
527 * @see Module::getDataLayout()
529 const char *LLVMGetDataLayout(LLVMModuleRef M);
532 * Set the data layout for a module.
534 * @see Module::setDataLayout()
536 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
539 * Obtain the target triple for a module.
541 * @see Module::getTargetTriple()
543 const char *LLVMGetTarget(LLVMModuleRef M);
546 * Set the target triple for a module.
548 * @see Module::setTargetTriple()
550 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
553 * Dump a representation of a module to stderr.
555 * @see Module::dump()
557 void LLVMDumpModule(LLVMModuleRef M);
560 * Print a representation of a module to a file. The ErrorMessage needs to be
561 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
563 * @see Module::print()
565 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
566 char **ErrorMessage);
569 * Return a string representation of the module. Use
570 * LLVMDisposeMessage to free the string.
572 * @see Module::print()
574 char *LLVMPrintModuleToString(LLVMModuleRef M);
577 * Set inline assembly for a module.
579 * @see Module::setModuleInlineAsm()
581 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
584 * Obtain the context to which this module is associated.
586 * @see Module::getContext()
588 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
591 * Obtain a Type from a module by its registered name.
593 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
596 * Obtain the number of operands for named metadata in a module.
598 * @see llvm::Module::getNamedMetadata()
600 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
603 * Obtain the named metadata operands for a module.
605 * The passed LLVMValueRef pointer should refer to an array of
606 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
607 * array will be populated with the LLVMValueRef instances. Each
608 * instance corresponds to a llvm::MDNode.
610 * @see llvm::Module::getNamedMetadata()
611 * @see llvm::MDNode::getOperand()
613 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
616 * Add an operand to named metadata.
618 * @see llvm::Module::getNamedMetadata()
619 * @see llvm::MDNode::addOperand()
621 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
625 * Add a function to a module under a specified name.
627 * @see llvm::Function::Create()
629 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
630 LLVMTypeRef FunctionTy);
633 * Obtain a Function value from a Module by its name.
635 * The returned value corresponds to a llvm::Function value.
637 * @see llvm::Module::getFunction()
639 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
642 * Obtain an iterator to the first Function in a Module.
644 * @see llvm::Module::begin()
646 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
649 * Obtain an iterator to the last Function in a Module.
651 * @see llvm::Module::end()
653 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
656 * Advance a Function iterator to the next Function.
658 * Returns NULL if the iterator was already at the end and there are no more
661 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
664 * Decrement a Function iterator to the previous Function.
666 * Returns NULL if the iterator was already at the beginning and there are
667 * no previous functions.
669 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
676 * @defgroup LLVMCCoreType Types
678 * Types represent the type of a value.
680 * Types are associated with a context instance. The context internally
681 * deduplicates types so there is only 1 instance of a specific type
682 * alive at a time. In other words, a unique type is shared among all
683 * consumers within a context.
685 * A Type in the C API corresponds to llvm::Type.
687 * Types have the following hierarchy:
705 * Obtain the enumerated type of a Type instance.
707 * @see llvm::Type:getTypeID()
709 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
712 * Whether the type has a known size.
714 * Things that don't have a size are abstract types, labels, and void.a
716 * @see llvm::Type::isSized()
718 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
721 * Obtain the context to which this type instance is associated.
723 * @see llvm::Type::getContext()
725 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
728 * Dump a representation of a type to stderr.
730 * @see llvm::Type::dump()
732 void LLVMDumpType(LLVMTypeRef Val);
735 * Return a string representation of the type. Use
736 * LLVMDisposeMessage to free the string.
738 * @see llvm::Type::print()
740 char *LLVMPrintTypeToString(LLVMTypeRef Val);
743 * @defgroup LLVMCCoreTypeInt Integer Types
745 * Functions in this section operate on integer types.
751 * Obtain an integer type from a context with specified bit width.
753 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
754 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
755 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
756 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
757 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
758 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
761 * Obtain an integer type from the global context with a specified bit
764 LLVMTypeRef LLVMInt1Type(void);
765 LLVMTypeRef LLVMInt8Type(void);
766 LLVMTypeRef LLVMInt16Type(void);
767 LLVMTypeRef LLVMInt32Type(void);
768 LLVMTypeRef LLVMInt64Type(void);
769 LLVMTypeRef LLVMIntType(unsigned NumBits);
770 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
777 * @defgroup LLVMCCoreTypeFloat Floating Point Types
783 * Obtain a 16-bit floating point type from a context.
785 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
788 * Obtain a 32-bit floating point type from a context.
790 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
793 * Obtain a 64-bit floating point type from a context.
795 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
798 * Obtain a 80-bit floating point type (X87) from a context.
800 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
803 * Obtain a 128-bit floating point type (112-bit mantissa) from a
806 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
809 * Obtain a 128-bit floating point type (two 64-bits) from a context.
811 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
814 * Obtain a floating point type from the global context.
816 * These map to the functions in this group of the same name.
818 LLVMTypeRef LLVMHalfType(void);
819 LLVMTypeRef LLVMFloatType(void);
820 LLVMTypeRef LLVMDoubleType(void);
821 LLVMTypeRef LLVMX86FP80Type(void);
822 LLVMTypeRef LLVMFP128Type(void);
823 LLVMTypeRef LLVMPPCFP128Type(void);
830 * @defgroup LLVMCCoreTypeFunction Function Types
836 * Obtain a function type consisting of a specified signature.
838 * The function is defined as a tuple of a return Type, a list of
839 * parameter types, and whether the function is variadic.
841 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
842 LLVMTypeRef *ParamTypes, unsigned ParamCount,
846 * Returns whether a function type is variadic.
848 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
851 * Obtain the Type this function Type returns.
853 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
856 * Obtain the number of parameters this function accepts.
858 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
861 * Obtain the types of a function's parameters.
863 * The Dest parameter should point to a pre-allocated array of
864 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
865 * first LLVMCountParamTypes() entries in the array will be populated
866 * with LLVMTypeRef instances.
868 * @param FunctionTy The function type to operate on.
869 * @param Dest Memory address of an array to be filled with result.
871 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
878 * @defgroup LLVMCCoreTypeStruct Structure Types
880 * These functions relate to LLVMTypeRef instances.
882 * @see llvm::StructType
888 * Create a new structure type in a context.
890 * A structure is specified by a list of inner elements/types and
891 * whether these can be packed together.
893 * @see llvm::StructType::create()
895 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
896 unsigned ElementCount, LLVMBool Packed);
899 * Create a new structure type in the global context.
901 * @see llvm::StructType::create()
903 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
907 * Create an empty structure in a context having a specified name.
909 * @see llvm::StructType::create()
911 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
914 * Obtain the name of a structure.
916 * @see llvm::StructType::getName()
918 const char *LLVMGetStructName(LLVMTypeRef Ty);
921 * Set the contents of a structure type.
923 * @see llvm::StructType::setBody()
925 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
926 unsigned ElementCount, LLVMBool Packed);
929 * Get the number of elements defined inside the structure.
931 * @see llvm::StructType::getNumElements()
933 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
936 * Get the elements within a structure.
938 * The function is passed the address of a pre-allocated array of
939 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
940 * invocation, this array will be populated with the structure's
941 * elements. The objects in the destination array will have a lifetime
942 * of the structure type itself, which is the lifetime of the context it
945 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
948 * Determine whether a structure is packed.
950 * @see llvm::StructType::isPacked()
952 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
955 * Determine whether a structure is opaque.
957 * @see llvm::StructType::isOpaque()
959 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
967 * @defgroup LLVMCCoreTypeSequential Sequential Types
969 * Sequential types represents "arrays" of types. This is a super class
970 * for array, vector, and pointer types.
976 * Obtain the type of elements within a sequential type.
978 * This works on array, vector, and pointer types.
980 * @see llvm::SequentialType::getElementType()
982 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
985 * Create a fixed size array type that refers to a specific type.
987 * The created type will exist in the context that its element type
990 * @see llvm::ArrayType::get()
992 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
995 * Obtain the length of an array type.
997 * This only works on types that represent arrays.
999 * @see llvm::ArrayType::getNumElements()
1001 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
1004 * Create a pointer type that points to a defined type.
1006 * The created type will exist in the context that its pointee type
1009 * @see llvm::PointerType::get()
1011 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
1014 * Obtain the address space of a pointer type.
1016 * This only works on types that represent pointers.
1018 * @see llvm::PointerType::getAddressSpace()
1020 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
1023 * Create a vector type that contains a defined type and has a specific
1024 * number of elements.
1026 * The created type will exist in the context thats its element type
1029 * @see llvm::VectorType::get()
1031 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
1034 * Obtain the number of elements in a vector type.
1036 * This only works on types that represent vectors.
1038 * @see llvm::VectorType::getNumElements()
1040 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1047 * @defgroup LLVMCCoreTypeOther Other Types
1053 * Create a void type in a context.
1055 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1058 * Create a label type in a context.
1060 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1063 * Create a X86 MMX type in a context.
1065 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1068 * These are similar to the above functions except they operate on the
1071 LLVMTypeRef LLVMVoidType(void);
1072 LLVMTypeRef LLVMLabelType(void);
1073 LLVMTypeRef LLVMX86MMXType(void);
1084 * @defgroup LLVMCCoreValues Values
1086 * The bulk of LLVM's object model consists of values, which comprise a very
1087 * rich type hierarchy.
1089 * LLVMValueRef essentially represents llvm::Value. There is a rich
1090 * hierarchy of classes within this type. Depending on the instance
1091 * obtained, not all APIs are available.
1093 * Callers can determine the type of an LLVMValueRef by calling the
1094 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1095 * functions are defined by a macro, so it isn't obvious which are
1096 * available by looking at the Doxygen source code. Instead, look at the
1097 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1098 * of value names given. These value names also correspond to classes in
1099 * the llvm::Value hierarchy.
1104 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1112 macro(BlockAddress) \
1113 macro(ConstantAggregateZero) \
1114 macro(ConstantArray) \
1115 macro(ConstantExpr) \
1117 macro(ConstantInt) \
1118 macro(ConstantPointerNull) \
1119 macro(ConstantStruct) \
1120 macro(ConstantVector) \
1121 macro(GlobalValue) \
1123 macro(GlobalAlias) \
1124 macro(GlobalVariable) \
1126 macro(Instruction) \
1127 macro(BinaryOperator) \
1129 macro(IntrinsicInst) \
1130 macro(DbgInfoIntrinsic) \
1131 macro(DbgDeclareInst) \
1132 macro(MemIntrinsic) \
1134 macro(MemMoveInst) \
1139 macro(ExtractElementInst) \
1140 macro(GetElementPtrInst) \
1141 macro(InsertElementInst) \
1142 macro(InsertValueInst) \
1143 macro(LandingPadInst) \
1146 macro(ShuffleVectorInst) \
1148 macro(TerminatorInst) \
1150 macro(IndirectBrInst) \
1154 macro(UnreachableInst) \
1156 macro(UnaryInstruction) \
1159 macro(BitCastInst) \
1163 macro(FPTruncInst) \
1164 macro(IntToPtrInst) \
1165 macro(PtrToIntInst) \
1171 macro(ExtractValueInst) \
1176 * @defgroup LLVMCCoreValueGeneral General APIs
1178 * Functions in this section work on all LLVMValueRef instances,
1179 * regardless of their sub-type. They correspond to functions available
1186 * Obtain the type of a value.
1188 * @see llvm::Value::getType()
1190 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1193 * Obtain the string name of a value.
1195 * @see llvm::Value::getName()
1197 const char *LLVMGetValueName(LLVMValueRef Val);
1200 * Set the string name of a value.
1202 * @see llvm::Value::setName()
1204 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1207 * Dump a representation of a value to stderr.
1209 * @see llvm::Value::dump()
1211 void LLVMDumpValue(LLVMValueRef Val);
1214 * Replace all uses of a value with another one.
1216 * @see llvm::Value::replaceAllUsesWith()
1218 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1221 * Determine whether the specified constant instance is constant.
1223 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1226 * Determine whether a value instance is undefined.
1228 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1231 * Convert value instances between types.
1233 * Internally, an LLVMValueRef is "pinned" to a specific type. This
1234 * series of functions allows you to cast an instance to a specific
1237 * If the cast is not valid for the specified type, NULL is returned.
1239 * @see llvm::dyn_cast_or_null<>
1241 #define LLVM_DECLARE_VALUE_CAST(name) \
1242 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1243 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1250 * @defgroup LLVMCCoreValueUses Usage
1252 * This module defines functions that allow you to inspect the uses of a
1255 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1256 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1257 * llvm::User and llvm::Value.
1263 * Obtain the first use of a value.
1265 * Uses are obtained in an iterator fashion. First, call this function
1266 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1267 * on that instance and all subsequently obtained instances until
1268 * LLVMGetNextUse() returns NULL.
1270 * @see llvm::Value::use_begin()
1272 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1275 * Obtain the next use of a value.
1277 * This effectively advances the iterator. It returns NULL if you are on
1278 * the final use and no more are available.
1280 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1283 * Obtain the user value for a user.
1285 * The returned value corresponds to a llvm::User type.
1287 * @see llvm::Use::getUser()
1289 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1292 * Obtain the value this use corresponds to.
1294 * @see llvm::Use::get().
1296 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1303 * @defgroup LLVMCCoreValueUser User value
1305 * Function in this group pertain to LLVMValueRef instances that descent
1306 * from llvm::User. This includes constants, instructions, and
1313 * Obtain an operand at a specific index in a llvm::User value.
1315 * @see llvm::User::getOperand()
1317 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1320 * Set an operand at a specific index in a llvm::User value.
1322 * @see llvm::User::setOperand()
1324 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1327 * Obtain the number of operands in a llvm::User value.
1329 * @see llvm::User::getNumOperands()
1331 int LLVMGetNumOperands(LLVMValueRef Val);
1338 * @defgroup LLVMCCoreValueConstant Constants
1340 * This section contains APIs for interacting with LLVMValueRef that
1341 * correspond to llvm::Constant instances.
1343 * These functions will work for any LLVMValueRef in the llvm::Constant
1350 * Obtain a constant value referring to the null instance of a type.
1352 * @see llvm::Constant::getNullValue()
1354 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1357 * Obtain a constant value referring to the instance of a type
1358 * consisting of all ones.
1360 * This is only valid for integer types.
1362 * @see llvm::Constant::getAllOnesValue()
1364 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1367 * Obtain a constant value referring to an undefined value of a type.
1369 * @see llvm::UndefValue::get()
1371 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1374 * Determine whether a value instance is null.
1376 * @see llvm::Constant::isNullValue()
1378 LLVMBool LLVMIsNull(LLVMValueRef Val);
1381 * Obtain a constant that is a constant pointer pointing to NULL for a
1384 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1387 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1389 * Functions in this group model LLVMValueRef instances that correspond
1390 * to constants referring to scalar types.
1392 * For integer types, the LLVMTypeRef parameter should correspond to a
1393 * llvm::IntegerType instance and the returned LLVMValueRef will
1394 * correspond to a llvm::ConstantInt.
1396 * For floating point types, the LLVMTypeRef returned corresponds to a
1403 * Obtain a constant value for an integer type.
1405 * The returned value corresponds to a llvm::ConstantInt.
1407 * @see llvm::ConstantInt::get()
1409 * @param IntTy Integer type to obtain value of.
1410 * @param N The value the returned instance should refer to.
1411 * @param SignExtend Whether to sign extend the produced value.
1413 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1414 LLVMBool SignExtend);
1417 * Obtain a constant value for an integer of arbitrary precision.
1419 * @see llvm::ConstantInt::get()
1421 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1423 const uint64_t Words[]);
1426 * Obtain a constant value for an integer parsed from a string.
1428 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1429 * string's length is available, it is preferred to call that function
1432 * @see llvm::ConstantInt::get()
1434 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1438 * Obtain a constant value for an integer parsed from a string with
1441 * @see llvm::ConstantInt::get()
1443 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1444 unsigned SLen, uint8_t Radix);
1447 * Obtain a constant value referring to a double floating point value.
1449 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1452 * Obtain a constant for a floating point value parsed from a string.
1454 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1455 * should be used if the input string's length is known.
1457 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1460 * Obtain a constant for a floating point value parsed from a string.
1462 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1466 * Obtain the zero extended value for an integer constant value.
1468 * @see llvm::ConstantInt::getZExtValue()
1470 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1473 * Obtain the sign extended value for an integer constant value.
1475 * @see llvm::ConstantInt::getSExtValue()
1477 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1484 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1486 * Functions in this group operate on composite constants.
1492 * Create a ConstantDataSequential and initialize it with a string.
1494 * @see llvm::ConstantDataArray::getString()
1496 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1497 unsigned Length, LLVMBool DontNullTerminate);
1500 * Create a ConstantDataSequential with string content in the global context.
1502 * This is the same as LLVMConstStringInContext except it operates on the
1505 * @see LLVMConstStringInContext()
1506 * @see llvm::ConstantDataArray::getString()
1508 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1509 LLVMBool DontNullTerminate);
1512 * Create an anonymous ConstantStruct with the specified values.
1514 * @see llvm::ConstantStruct::getAnon()
1516 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1517 LLVMValueRef *ConstantVals,
1518 unsigned Count, LLVMBool Packed);
1521 * Create a ConstantStruct in the global Context.
1523 * This is the same as LLVMConstStructInContext except it operates on the
1526 * @see LLVMConstStructInContext()
1528 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1532 * Create a ConstantArray from values.
1534 * @see llvm::ConstantArray::get()
1536 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1537 LLVMValueRef *ConstantVals, unsigned Length);
1540 * Create a non-anonymous ConstantStruct from values.
1542 * @see llvm::ConstantStruct::get()
1544 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1545 LLVMValueRef *ConstantVals,
1549 * Create a ConstantVector from values.
1551 * @see llvm::ConstantVector::get()
1553 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1560 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1562 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1564 * @see llvm::ConstantExpr.
1568 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1569 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1570 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1571 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1572 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1573 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1574 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1575 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1576 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1577 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1578 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1579 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1580 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1581 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1582 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1583 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1584 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1585 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1586 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1587 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1588 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1589 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1590 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1591 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1592 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1593 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1594 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1595 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1596 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1597 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1598 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1599 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1600 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1601 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1602 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1603 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1604 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1605 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1606 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1607 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1608 LLVMValueRef *ConstantIndices,
1609 unsigned NumIndices);
1610 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1611 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1612 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1613 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1614 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1615 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1616 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1617 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1618 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1619 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1620 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1621 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1622 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1623 LLVMTypeRef ToType);
1624 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1625 LLVMTypeRef ToType);
1626 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1627 LLVMTypeRef ToType);
1628 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1629 LLVMTypeRef ToType);
1630 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1632 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1633 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1634 LLVMValueRef ConstantIfTrue,
1635 LLVMValueRef ConstantIfFalse);
1636 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1637 LLVMValueRef IndexConstant);
1638 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1639 LLVMValueRef ElementValueConstant,
1640 LLVMValueRef IndexConstant);
1641 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1642 LLVMValueRef VectorBConstant,
1643 LLVMValueRef MaskConstant);
1644 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1646 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1647 LLVMValueRef ElementValueConstant,
1648 unsigned *IdxList, unsigned NumIdx);
1649 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1650 const char *AsmString, const char *Constraints,
1651 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1652 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1659 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1661 * This group contains functions that operate on global values. Functions in
1662 * this group relate to functions in the llvm::GlobalValue class tree.
1664 * @see llvm::GlobalValue
1669 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1670 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1671 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1672 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1673 const char *LLVMGetSection(LLVMValueRef Global);
1674 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1675 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1676 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1679 * @defgroup LLVMCCoreValueWithAlignment Values with alignment
1681 * Functions in this group only apply to values with alignment, i.e.
1682 * global variables, load and store instructions.
1686 * Obtain the preferred alignment of the value.
1687 * @see llvm::LoadInst::getAlignment()
1688 * @see llvm::StoreInst::getAlignment()
1689 * @see llvm::GlobalValue::getAlignment()
1691 unsigned LLVMGetAlignment(LLVMValueRef V);
1694 * Set the preferred alignment of the value.
1695 * @see llvm::LoadInst::setAlignment()
1696 * @see llvm::StoreInst::setAlignment()
1697 * @see llvm::GlobalValue::setAlignment()
1699 void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes);
1706 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1708 * This group contains functions that operate on global variable values.
1710 * @see llvm::GlobalVariable
1714 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1715 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1717 unsigned AddressSpace);
1718 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1719 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1720 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1721 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1722 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1723 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1724 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1725 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1726 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1727 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1728 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1729 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1730 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1731 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1732 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1733 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1740 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1742 * This group contains function that operate on global alias values.
1744 * @see llvm::GlobalAlias
1748 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1756 * @defgroup LLVMCCoreValueFunction Function values
1758 * Functions in this group operate on LLVMValueRef instances that
1759 * correspond to llvm::Function instances.
1761 * @see llvm::Function
1767 * Remove a function from its containing module and deletes it.
1769 * @see llvm::Function::eraseFromParent()
1771 void LLVMDeleteFunction(LLVMValueRef Fn);
1774 * Obtain the ID number from a function instance.
1776 * @see llvm::Function::getIntrinsicID()
1778 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1781 * Obtain the calling function of a function.
1783 * The returned value corresponds to the LLVMCallConv enumeration.
1785 * @see llvm::Function::getCallingConv()
1787 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1790 * Set the calling convention of a function.
1792 * @see llvm::Function::setCallingConv()
1794 * @param Fn Function to operate on
1795 * @param CC LLVMCallConv to set calling convention to
1797 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1800 * Obtain the name of the garbage collector to use during code
1803 * @see llvm::Function::getGC()
1805 const char *LLVMGetGC(LLVMValueRef Fn);
1808 * Define the garbage collector to use during code generation.
1810 * @see llvm::Function::setGC()
1812 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1815 * Add an attribute to a function.
1817 * @see llvm::Function::addAttribute()
1819 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1822 * Add a target-dependent attribute to a fuction
1823 * @see llvm::AttrBuilder::addAttribute()
1825 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1829 * Obtain an attribute from a function.
1831 * @see llvm::Function::getAttributes()
1833 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1836 * Remove an attribute from a function.
1838 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1841 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1843 * Functions in this group relate to arguments/parameters on functions.
1845 * Functions in this group expect LLVMValueRef instances that correspond
1846 * to llvm::Function instances.
1852 * Obtain the number of parameters in a function.
1854 * @see llvm::Function::arg_size()
1856 unsigned LLVMCountParams(LLVMValueRef Fn);
1859 * Obtain the parameters in a function.
1861 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1862 * at least LLVMCountParams() long. This array will be filled with
1863 * LLVMValueRef instances which correspond to the parameters the
1864 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1867 * @see llvm::Function::arg_begin()
1869 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1872 * Obtain the parameter at the specified index.
1874 * Parameters are indexed from 0.
1876 * @see llvm::Function::arg_begin()
1878 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1881 * Obtain the function to which this argument belongs.
1883 * Unlike other functions in this group, this one takes an LLVMValueRef
1884 * that corresponds to a llvm::Attribute.
1886 * The returned LLVMValueRef is the llvm::Function to which this
1889 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1892 * Obtain the first parameter to a function.
1894 * @see llvm::Function::arg_begin()
1896 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1899 * Obtain the last parameter to a function.
1901 * @see llvm::Function::arg_end()
1903 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
1906 * Obtain the next parameter to a function.
1908 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
1909 * actually a wrapped iterator) and obtains the next parameter from the
1910 * underlying iterator.
1912 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
1915 * Obtain the previous parameter to a function.
1917 * This is the opposite of LLVMGetNextParam().
1919 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
1922 * Add an attribute to a function argument.
1924 * @see llvm::Argument::addAttr()
1926 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1929 * Remove an attribute from a function argument.
1931 * @see llvm::Argument::removeAttr()
1933 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1936 * Get an attribute from a function argument.
1938 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
1941 * Set the alignment for a function parameter.
1943 * @see llvm::Argument::addAttr()
1944 * @see llvm::AttrBuilder::addAlignmentAttr()
1946 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
1965 * @defgroup LLVMCCoreValueMetadata Metadata
1971 * Obtain a MDString value from a context.
1973 * The returned instance corresponds to the llvm::MDString class.
1975 * The instance is specified by string data of a specified length. The
1976 * string content is copied, so the backing memory can be freed after
1977 * this function returns.
1979 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
1983 * Obtain a MDString value from the global context.
1985 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
1988 * Obtain a MDNode value from a context.
1990 * The returned value corresponds to the llvm::MDNode class.
1992 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
1996 * Obtain a MDNode value from the global context.
1998 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
2001 * Obtain the underlying string from a MDString value.
2003 * @param V Instance to obtain string from.
2004 * @param Len Memory address which will hold length of returned string.
2005 * @return String data in MDString.
2007 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
2010 * Obtain the number of operands from an MDNode value.
2012 * @param V MDNode to get number of operands from.
2013 * @return Number of operands of the MDNode.
2015 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
2018 * Obtain the given MDNode's operands.
2020 * The passed LLVMValueRef pointer should point to enough memory to hold all of
2021 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
2022 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
2023 * MDNode's operands.
2025 * @param V MDNode to get the operands from.
2026 * @param Dest Destination array for operands.
2028 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
2035 * @defgroup LLVMCCoreValueBasicBlock Basic Block
2037 * A basic block represents a single entry single exit section of code.
2038 * Basic blocks contain a list of instructions which form the body of
2041 * Basic blocks belong to functions. They have the type of label.
2043 * Basic blocks are themselves values. However, the C API models them as
2044 * LLVMBasicBlockRef.
2046 * @see llvm::BasicBlock
2052 * Convert a basic block instance to a value type.
2054 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
2057 * Determine whether an LLVMValueRef is itself a basic block.
2059 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
2062 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
2064 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
2067 * Obtain the function to which a basic block belongs.
2069 * @see llvm::BasicBlock::getParent()
2071 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2074 * Obtain the terminator instruction for a basic block.
2076 * If the basic block does not have a terminator (it is not well-formed
2077 * if it doesn't), then NULL is returned.
2079 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2081 * @see llvm::BasicBlock::getTerminator()
2083 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2086 * Obtain the number of basic blocks in a function.
2088 * @param Fn Function value to operate on.
2090 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2093 * Obtain all of the basic blocks in a function.
2095 * This operates on a function value. The BasicBlocks parameter is a
2096 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2097 * LLVMCountBasicBlocks() in length. This array is populated with
2098 * LLVMBasicBlockRef instances.
2100 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2103 * Obtain the first basic block in a function.
2105 * The returned basic block can be used as an iterator. You will likely
2106 * eventually call into LLVMGetNextBasicBlock() with it.
2108 * @see llvm::Function::begin()
2110 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2113 * Obtain the last basic block in a function.
2115 * @see llvm::Function::end()
2117 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2120 * Advance a basic block iterator.
2122 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2125 * Go backwards in a basic block iterator.
2127 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2130 * Obtain the basic block that corresponds to the entry point of a
2133 * @see llvm::Function::getEntryBlock()
2135 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2138 * Append a basic block to the end of a function.
2140 * @see llvm::BasicBlock::Create()
2142 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2147 * Append a basic block to the end of a function using the global
2150 * @see llvm::BasicBlock::Create()
2152 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2155 * Insert a basic block in a function before another basic block.
2157 * The function to add to is determined by the function of the
2158 * passed basic block.
2160 * @see llvm::BasicBlock::Create()
2162 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2163 LLVMBasicBlockRef BB,
2167 * Insert a basic block in a function using the global context.
2169 * @see llvm::BasicBlock::Create()
2171 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2175 * Remove a basic block from a function and delete it.
2177 * This deletes the basic block from its containing function and deletes
2178 * the basic block itself.
2180 * @see llvm::BasicBlock::eraseFromParent()
2182 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2185 * Remove a basic block from a function.
2187 * This deletes the basic block from its containing function but keep
2188 * the basic block alive.
2190 * @see llvm::BasicBlock::removeFromParent()
2192 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2195 * Move a basic block to before another one.
2197 * @see llvm::BasicBlock::moveBefore()
2199 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2202 * Move a basic block to after another one.
2204 * @see llvm::BasicBlock::moveAfter()
2206 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2209 * Obtain the first instruction in a basic block.
2211 * The returned LLVMValueRef corresponds to a llvm::Instruction
2214 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2217 * Obtain the last instruction in a basic block.
2219 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2221 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2228 * @defgroup LLVMCCoreValueInstruction Instructions
2230 * Functions in this group relate to the inspection and manipulation of
2231 * individual instructions.
2233 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2234 * class has a large number of descendents. llvm::Instruction is a
2235 * llvm::Value and in the C API, instructions are modeled by
2238 * This group also contains sub-groups which operate on specific
2239 * llvm::Instruction types, e.g. llvm::CallInst.
2245 * Determine whether an instruction has any metadata attached.
2247 int LLVMHasMetadata(LLVMValueRef Val);
2250 * Return metadata associated with an instruction value.
2252 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2255 * Set metadata associated with an instruction value.
2257 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2260 * Obtain the basic block to which an instruction belongs.
2262 * @see llvm::Instruction::getParent()
2264 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2267 * Obtain the instruction that occurs after the one specified.
2269 * The next instruction will be from the same basic block.
2271 * If this is the last instruction in a basic block, NULL will be
2274 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2277 * Obtain the instruction that occurred before this one.
2279 * If the instruction is the first instruction in a basic block, NULL
2282 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2285 * Remove and delete an instruction.
2287 * The instruction specified is removed from its containing building
2288 * block and then deleted.
2290 * @see llvm::Instruction::eraseFromParent()
2292 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2295 * Obtain the code opcode for an individual instruction.
2297 * @see llvm::Instruction::getOpCode()
2299 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2302 * Obtain the predicate of an instruction.
2304 * This is only valid for instructions that correspond to llvm::ICmpInst
2305 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2307 * @see llvm::ICmpInst::getPredicate()
2309 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2312 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2314 * Functions in this group apply to instructions that refer to call
2315 * sites and invocations. These correspond to C++ types in the
2316 * llvm::CallInst class tree.
2322 * Set the calling convention for a call instruction.
2324 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2327 * @see llvm::CallInst::setCallingConv()
2328 * @see llvm::InvokeInst::setCallingConv()
2330 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2333 * Obtain the calling convention for a call instruction.
2335 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2338 * @see LLVMSetInstructionCallConv()
2340 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2343 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2344 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2346 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2350 * Obtain whether a call instruction is a tail call.
2352 * This only works on llvm::CallInst instructions.
2354 * @see llvm::CallInst::isTailCall()
2356 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2359 * Set whether a call instruction is a tail call.
2361 * This only works on llvm::CallInst instructions.
2363 * @see llvm::CallInst::setTailCall()
2365 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2372 * Obtain the default destination basic block of a switch instruction.
2374 * This only works on llvm::SwitchInst instructions.
2376 * @see llvm::SwitchInst::getDefaultDest()
2378 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2381 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2383 * Functions in this group only apply to instructions that map to
2384 * llvm::PHINode instances.
2390 * Add an incoming value to the end of a PHI list.
2392 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2393 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2396 * Obtain the number of incoming basic blocks to a PHI node.
2398 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2401 * Obtain an incoming value to a PHI node as an LLVMValueRef.
2403 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2406 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2408 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2423 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2425 * An instruction builder represents a point within a basic block and is
2426 * the exclusive means of building instructions using the C interface.
2431 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2432 LLVMBuilderRef LLVMCreateBuilder(void);
2433 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2434 LLVMValueRef Instr);
2435 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2436 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2437 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2438 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2439 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2440 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2442 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2445 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2446 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2447 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2450 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2451 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2452 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2454 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2455 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2456 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2457 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2458 LLVMBasicBlockRef Else, unsigned NumCases);
2459 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2461 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2462 LLVMValueRef *Args, unsigned NumArgs,
2463 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2465 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2466 LLVMValueRef PersFn, unsigned NumClauses,
2468 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2469 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2471 /* Add a case to the switch instruction */
2472 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2473 LLVMBasicBlockRef Dest);
2475 /* Add a destination to the indirectbr instruction */
2476 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2478 /* Add a catch or filter clause to the landingpad instruction */
2479 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2481 /* Set the 'cleanup' flag in the landingpad instruction */
2482 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2485 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2487 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2489 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2491 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2493 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2495 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2497 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2499 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2501 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2503 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2505 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2507 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2509 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2511 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2513 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2515 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2517 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2519 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2521 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2523 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2525 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2527 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2529 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2531 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2533 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2535 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2536 LLVMValueRef LHS, LLVMValueRef RHS,
2538 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2539 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2541 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2543 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2544 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2547 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2548 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2549 LLVMValueRef Val, const char *Name);
2550 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2551 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2552 LLVMValueRef Val, const char *Name);
2553 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2554 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2556 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2557 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2558 LLVMValueRef *Indices, unsigned NumIndices,
2560 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2561 LLVMValueRef *Indices, unsigned NumIndices,
2563 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2564 unsigned Idx, const char *Name);
2565 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2567 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2569 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2570 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2573 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2574 LLVMTypeRef DestTy, const char *Name);
2575 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2576 LLVMTypeRef DestTy, const char *Name);
2577 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2578 LLVMTypeRef DestTy, const char *Name);
2579 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2580 LLVMTypeRef DestTy, const char *Name);
2581 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2582 LLVMTypeRef DestTy, const char *Name);
2583 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2584 LLVMTypeRef DestTy, const char *Name);
2585 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2586 LLVMTypeRef DestTy, const char *Name);
2587 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2588 LLVMTypeRef DestTy, const char *Name);
2589 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2590 LLVMTypeRef DestTy, const char *Name);
2591 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2592 LLVMTypeRef DestTy, const char *Name);
2593 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2594 LLVMTypeRef DestTy, const char *Name);
2595 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2596 LLVMTypeRef DestTy, const char *Name);
2597 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2598 LLVMTypeRef DestTy, const char *Name);
2599 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2600 LLVMTypeRef DestTy, const char *Name);
2601 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2602 LLVMTypeRef DestTy, const char *Name);
2603 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2604 LLVMTypeRef DestTy, const char *Name);
2605 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2606 LLVMTypeRef DestTy, const char *Name);
2607 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2608 LLVMTypeRef DestTy, const char *Name);
2609 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2610 LLVMTypeRef DestTy, const char *Name);
2613 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2614 LLVMValueRef LHS, LLVMValueRef RHS,
2616 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2617 LLVMValueRef LHS, LLVMValueRef RHS,
2620 /* Miscellaneous instructions */
2621 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2622 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2623 LLVMValueRef *Args, unsigned NumArgs,
2625 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2626 LLVMValueRef Then, LLVMValueRef Else,
2628 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2630 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2631 LLVMValueRef Index, const char *Name);
2632 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2633 LLVMValueRef EltVal, LLVMValueRef Index,
2635 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2636 LLVMValueRef V2, LLVMValueRef Mask,
2638 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2639 unsigned Index, const char *Name);
2640 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2641 LLVMValueRef EltVal, unsigned Index,
2644 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2646 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2648 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2649 LLVMValueRef RHS, const char *Name);
2650 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B,LLVMAtomicRMWBinOp op,
2651 LLVMValueRef PTR, LLVMValueRef Val,
2652 LLVMAtomicOrdering ordering,
2653 LLVMBool singleThread);
2660 * @defgroup LLVMCCoreModuleProvider Module Providers
2666 * Changes the type of M so it can be passed to FunctionPassManagers and the
2667 * JIT. They take ModuleProviders for historical reasons.
2669 LLVMModuleProviderRef
2670 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2673 * Destroys the module M.
2675 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2682 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2687 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2688 LLVMMemoryBufferRef *OutMemBuf,
2690 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2692 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2693 size_t InputDataLength,
2694 const char *BufferName,
2695 LLVMBool RequiresNullTerminator);
2696 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2697 size_t InputDataLength,
2698 const char *BufferName);
2699 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2700 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2701 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2708 * @defgroup LLVMCCorePassRegistry Pass Registry
2713 /** Return the global pass registry, for use with initialization functions.
2714 @see llvm::PassRegistry::getPassRegistry */
2715 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2722 * @defgroup LLVMCCorePassManagers Pass Managers
2727 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2728 suitable for link-time optimization and whole-module transformations.
2729 @see llvm::PassManager::PassManager */
2730 LLVMPassManagerRef LLVMCreatePassManager(void);
2732 /** Constructs a new function-by-function pass pipeline over the module
2733 provider. It does not take ownership of the module provider. This type of
2734 pipeline is suitable for code generation and JIT compilation tasks.
2735 @see llvm::FunctionPassManager::FunctionPassManager */
2736 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2738 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2739 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2741 /** Initializes, executes on the provided module, and finalizes all of the
2742 passes scheduled in the pass manager. Returns 1 if any of the passes
2743 modified the module, 0 otherwise.
2744 @see llvm::PassManager::run(Module&) */
2745 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2747 /** Initializes all of the function passes scheduled in the function pass
2748 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2749 @see llvm::FunctionPassManager::doInitialization */
2750 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2752 /** Executes all of the function passes scheduled in the function pass manager
2753 on the provided function. Returns 1 if any of the passes modified the
2754 function, false otherwise.
2755 @see llvm::FunctionPassManager::run(Function&) */
2756 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2758 /** Finalizes all of the function passes scheduled in in the function pass
2759 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2760 @see llvm::FunctionPassManager::doFinalization */
2761 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2763 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2764 the module provider.
2765 @see llvm::PassManagerBase::~PassManagerBase. */
2766 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2773 * @defgroup LLVMCCoreThreading Threading
2775 * Handle the structures needed to make LLVM safe for multithreading.
2780 /** Allocate and initialize structures needed to make LLVM safe for
2781 multithreading. The return value indicates whether multithreaded
2782 initialization succeeded. Must be executed in isolation from all
2783 other LLVM api calls.
2784 @see llvm::llvm_start_multithreaded */
2785 LLVMBool LLVMStartMultithreaded(void);
2787 /** Deallocate structures necessary to make LLVM safe for multithreading.
2788 Must be executed in isolation from all other LLVM api calls.
2789 @see llvm::llvm_stop_multithreaded */
2790 void LLVMStopMultithreaded(void);
2792 /** Check whether LLVM is executing in thread-safe mode or not.
2793 @see llvm::llvm_is_multithreaded */
2794 LLVMBool LLVMIsMultithreaded(void);
2810 #endif /* !defined(__cplusplus) */
2812 #endif /* !defined(LLVM_C_CORE_H) */