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"
22 /* Need these includes to support the LLVM 'cast' template for the C++ 'wrap'
23 and 'unwrap' conversion functions. */
24 #include "llvm/IR/IRBuilder.h"
25 #include "llvm/IR/Module.h"
26 #include "llvm/PassRegistry.h"
32 * @defgroup LLVMC LLVM-C: C interface to LLVM
34 * This module exposes parts of the LLVM library as a C API.
40 * @defgroup LLVMCTransforms Transforms
44 * @defgroup LLVMCCore Core
46 * This modules provide an interface to libLLVMCore, which implements
47 * the LLVM intermediate representation as well as other related types
50 * LLVM uses a polymorphic type hierarchy which C cannot represent, therefore
51 * parameters must be passed as base types. Despite the declared types, most
52 * of the functions provided operate only on branches of the type hierarchy.
53 * The declared parameter names are descriptive and specify which type is
54 * required. Additionally, each type hierarchy is documented along with the
55 * functions that operate upon it. For more detail, refer to LLVM's C++ code.
56 * If in doubt, refer to Core.cpp, which performs parameter downcasts in the
57 * form unwrap<RequiredType>(Param).
59 * Many exotic languages can interoperate with C code but have a harder time
60 * with C++ due to name mangling. So in addition to C, this interface enables
61 * tools written in such languages.
63 * When included into a C++ source file, also declares 'wrap' and 'unwrap'
64 * helpers to perform opaque reference<-->pointer conversions. These helpers
65 * are shorter and more tightly typed than writing the casts by hand when
66 * authoring bindings. In assert builds, they will do runtime type checking.
72 * @defgroup LLVMCCoreTypes Types and Enumerations
82 * The top-level container for all LLVM global data. See the LLVMContext class.
84 typedef struct LLVMOpaqueContext *LLVMContextRef;
87 * The top-level container for all other LLVM Intermediate Representation (IR)
92 typedef struct LLVMOpaqueModule *LLVMModuleRef;
95 * Each value in the LLVM IR has a type, an LLVMTypeRef.
99 typedef struct LLVMOpaqueType *LLVMTypeRef;
102 * Represents an individual value in LLVM IR.
104 * This models llvm::Value.
106 typedef struct LLVMOpaqueValue *LLVMValueRef;
109 * Represents a basic block of instructions in LLVM IR.
111 * This models llvm::BasicBlock.
113 typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
116 * Represents an LLVM basic block builder.
118 * This models llvm::IRBuilder.
120 typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
123 * Interface used to provide a module to JIT or interpreter.
124 * This is now just a synonym for llvm::Module, but we have to keep using the
125 * different type to keep binary compatibility.
127 typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
130 * Used to provide a module to JIT or interpreter.
132 * @see llvm::MemoryBuffer
134 typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
136 /** @see llvm::PassManagerBase */
137 typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
139 /** @see llvm::PassRegistry */
140 typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef;
143 * Used to get the users and usees of a Value.
146 typedef struct LLVMOpaqueUse *LLVMUseRef;
149 LLVMZExtAttribute = 1<<0,
150 LLVMSExtAttribute = 1<<1,
151 LLVMNoReturnAttribute = 1<<2,
152 LLVMInRegAttribute = 1<<3,
153 LLVMStructRetAttribute = 1<<4,
154 LLVMNoUnwindAttribute = 1<<5,
155 LLVMNoAliasAttribute = 1<<6,
156 LLVMByValAttribute = 1<<7,
157 LLVMNestAttribute = 1<<8,
158 LLVMReadNoneAttribute = 1<<9,
159 LLVMReadOnlyAttribute = 1<<10,
160 LLVMNoInlineAttribute = 1<<11,
161 LLVMAlwaysInlineAttribute = 1<<12,
162 LLVMOptimizeForSizeAttribute = 1<<13,
163 LLVMStackProtectAttribute = 1<<14,
164 LLVMStackProtectReqAttribute = 1<<15,
165 LLVMAlignment = 31<<16,
166 LLVMNoCaptureAttribute = 1<<21,
167 LLVMNoRedZoneAttribute = 1<<22,
168 LLVMNoImplicitFloatAttribute = 1<<23,
169 LLVMNakedAttribute = 1<<24,
170 LLVMInlineHintAttribute = 1<<25,
171 LLVMStackAlignment = 7<<26,
172 LLVMReturnsTwice = 1 << 29,
173 LLVMUWTable = 1 << 30,
174 LLVMNonLazyBind = 1 << 31
176 /* FIXME: These attributes are currently not included in the C API as
177 a temporary measure until the API/ABI impact to the C API is understood
178 and the path forward agreed upon.
179 LLVMAddressSafety = 1ULL << 32,
180 LLVMStackProtectStrongAttribute = 1ULL<<33
185 /* Terminator Instructions */
191 /* removed 6 due to API changes */
194 /* Standard Binary Operators */
208 /* Logical Operators */
216 /* Memory Operators */
220 LLVMGetElementPtr = 29,
236 /* Other Operators */
245 LLVMExtractElement = 50,
246 LLVMInsertElement = 51,
247 LLVMShuffleVector = 52,
248 LLVMExtractValue = 53,
249 LLVMInsertValue = 54,
251 /* Atomic operators */
253 LLVMAtomicCmpXchg = 56,
256 /* Exception Handling Operators */
263 LLVMVoidTypeKind, /**< type with no size */
264 LLVMHalfTypeKind, /**< 16 bit floating point type */
265 LLVMFloatTypeKind, /**< 32 bit floating point type */
266 LLVMDoubleTypeKind, /**< 64 bit floating point type */
267 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
268 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
269 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
270 LLVMLabelTypeKind, /**< Labels */
271 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
272 LLVMFunctionTypeKind, /**< Functions */
273 LLVMStructTypeKind, /**< Structures */
274 LLVMArrayTypeKind, /**< Arrays */
275 LLVMPointerTypeKind, /**< Pointers */
276 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
277 LLVMMetadataTypeKind, /**< Metadata */
278 LLVMX86_MMXTypeKind /**< X86 MMX */
282 LLVMExternalLinkage, /**< Externally visible function */
283 LLVMAvailableExternallyLinkage,
284 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
285 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
287 LLVMLinkOnceODRAutoHideLinkage, /**< Like LinkOnceODR, but possibly hidden. */
288 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
289 LLVMWeakODRLinkage, /**< Same, but only replaced by something
291 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
292 LLVMInternalLinkage, /**< Rename collisions when linking (static
294 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
295 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
296 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
297 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
298 LLVMGhostLinkage, /**< Obsolete */
299 LLVMCommonLinkage, /**< Tentative definitions */
300 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
301 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
305 LLVMDefaultVisibility, /**< The GV is visible */
306 LLVMHiddenVisibility, /**< The GV is hidden */
307 LLVMProtectedVisibility /**< The GV is protected */
312 LLVMFastCallConv = 8,
313 LLVMColdCallConv = 9,
314 LLVMX86StdcallCallConv = 64,
315 LLVMX86FastcallCallConv = 65
319 LLVMIntEQ = 32, /**< equal */
320 LLVMIntNE, /**< not equal */
321 LLVMIntUGT, /**< unsigned greater than */
322 LLVMIntUGE, /**< unsigned greater or equal */
323 LLVMIntULT, /**< unsigned less than */
324 LLVMIntULE, /**< unsigned less or equal */
325 LLVMIntSGT, /**< signed greater than */
326 LLVMIntSGE, /**< signed greater or equal */
327 LLVMIntSLT, /**< signed less than */
328 LLVMIntSLE /**< signed less or equal */
332 LLVMRealPredicateFalse, /**< Always false (always folded) */
333 LLVMRealOEQ, /**< True if ordered and equal */
334 LLVMRealOGT, /**< True if ordered and greater than */
335 LLVMRealOGE, /**< True if ordered and greater than or equal */
336 LLVMRealOLT, /**< True if ordered and less than */
337 LLVMRealOLE, /**< True if ordered and less than or equal */
338 LLVMRealONE, /**< True if ordered and operands are unequal */
339 LLVMRealORD, /**< True if ordered (no nans) */
340 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
341 LLVMRealUEQ, /**< True if unordered or equal */
342 LLVMRealUGT, /**< True if unordered or greater than */
343 LLVMRealUGE, /**< True if unordered, greater than, or equal */
344 LLVMRealULT, /**< True if unordered or less than */
345 LLVMRealULE, /**< True if unordered, less than, or equal */
346 LLVMRealUNE, /**< True if unordered or not equal */
347 LLVMRealPredicateTrue /**< Always true (always folded) */
351 LLVMLandingPadCatch, /**< A catch clause */
352 LLVMLandingPadFilter /**< A filter clause */
353 } LLVMLandingPadClauseTy;
356 LLVMNotThreadLocal = 0,
357 LLVMGeneralDynamicTLSModel,
358 LLVMLocalDynamicTLSModel,
359 LLVMInitialExecTLSModel,
360 LLVMLocalExecTLSModel
361 } LLVMThreadLocalMode;
367 void LLVMInitializeCore(LLVMPassRegistryRef R);
369 /** Deallocate and destroy all ManagedStatic variables.
370 @see llvm::llvm_shutdown
371 @see ManagedStatic */
375 /*===-- Error handling ----------------------------------------------------===*/
377 void LLVMDisposeMessage(char *Message);
381 * @defgroup LLVMCCoreContext Contexts
383 * Contexts are execution states for the core LLVM IR system.
385 * Most types are tied to a context instance. Multiple contexts can
386 * exist simultaneously. A single context is not thread safe. However,
387 * different contexts can execute on different threads simultaneously.
393 * Create a new context.
395 * Every call to this function should be paired with a call to
396 * LLVMContextDispose() or the context will leak memory.
398 LLVMContextRef LLVMContextCreate(void);
401 * Obtain the global context instance.
403 LLVMContextRef LLVMGetGlobalContext(void);
406 * Destroy a context instance.
408 * This should be called for every call to LLVMContextCreate() or memory
411 void LLVMContextDispose(LLVMContextRef C);
413 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
415 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
422 * @defgroup LLVMCCoreModule Modules
424 * Modules represent the top-level structure in a LLVM program. An LLVM
425 * module is effectively a translation unit or a collection of
426 * translation units merged together.
432 * Create a new, empty module in the global context.
434 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
435 * LLVMGetGlobalContext() as the context parameter.
437 * Every invocation should be paired with LLVMDisposeModule() or memory
440 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
443 * Create a new, empty module in a specific context.
445 * Every invocation should be paired with LLVMDisposeModule() or memory
448 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
452 * Destroy a module instance.
454 * This must be called for every created module or memory will be
457 void LLVMDisposeModule(LLVMModuleRef M);
460 * Obtain the data layout for a module.
462 * @see Module::getDataLayout()
464 const char *LLVMGetDataLayout(LLVMModuleRef M);
467 * Set the data layout for a module.
469 * @see Module::setDataLayout()
471 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
474 * Obtain the target triple for a module.
476 * @see Module::getTargetTriple()
478 const char *LLVMGetTarget(LLVMModuleRef M);
481 * Set the target triple for a module.
483 * @see Module::setTargetTriple()
485 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
488 * Dump a representation of a module to stderr.
490 * @see Module::dump()
492 void LLVMDumpModule(LLVMModuleRef M);
495 * Print a representation of a module to a file. The ErrorMessage needs to be
496 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
498 * @see Module::print()
500 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
501 char **ErrorMessage);
504 * Set inline assembly for a module.
506 * @see Module::setModuleInlineAsm()
508 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
511 * Obtain the context to which this module is associated.
513 * @see Module::getContext()
515 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
518 * Obtain a Type from a module by its registered name.
520 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
523 * Obtain the number of operands for named metadata in a module.
525 * @see llvm::Module::getNamedMetadata()
527 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
530 * Obtain the named metadata operands for a module.
532 * The passed LLVMValueRef pointer should refer to an array of
533 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
534 * array will be populated with the LLVMValueRef instances. Each
535 * instance corresponds to a llvm::MDNode.
537 * @see llvm::Module::getNamedMetadata()
538 * @see llvm::MDNode::getOperand()
540 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
543 * Add an operand to named metadata.
545 * @see llvm::Module::getNamedMetadata()
546 * @see llvm::MDNode::addOperand()
548 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
552 * Add a function to a module under a specified name.
554 * @see llvm::Function::Create()
556 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
557 LLVMTypeRef FunctionTy);
560 * Obtain a Function value from a Module by its name.
562 * The returned value corresponds to a llvm::Function value.
564 * @see llvm::Module::getFunction()
566 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
569 * Obtain an iterator to the first Function in a Module.
571 * @see llvm::Module::begin()
573 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
576 * Obtain an iterator to the last Function in a Module.
578 * @see llvm::Module::end()
580 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
583 * Advance a Function iterator to the next Function.
585 * Returns NULL if the iterator was already at the end and there are no more
588 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
591 * Decrement a Function iterator to the previous Function.
593 * Returns NULL if the iterator was already at the beginning and there are
594 * no previous functions.
596 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
603 * @defgroup LLVMCCoreType Types
605 * Types represent the type of a value.
607 * Types are associated with a context instance. The context internally
608 * deduplicates types so there is only 1 instance of a specific type
609 * alive at a time. In other words, a unique type is shared among all
610 * consumers within a context.
612 * A Type in the C API corresponds to llvm::Type.
614 * Types have the following hierarchy:
632 * Obtain the enumerated type of a Type instance.
634 * @see llvm::Type:getTypeID()
636 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
639 * Whether the type has a known size.
641 * Things that don't have a size are abstract types, labels, and void.a
643 * @see llvm::Type::isSized()
645 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
648 * Obtain the context to which this type instance is associated.
650 * @see llvm::Type::getContext()
652 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
655 * @defgroup LLVMCCoreTypeInt Integer Types
657 * Functions in this section operate on integer types.
663 * Obtain an integer type from a context with specified bit width.
665 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
666 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
667 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
668 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
669 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
670 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
673 * Obtain an integer type from the global context with a specified bit
676 LLVMTypeRef LLVMInt1Type(void);
677 LLVMTypeRef LLVMInt8Type(void);
678 LLVMTypeRef LLVMInt16Type(void);
679 LLVMTypeRef LLVMInt32Type(void);
680 LLVMTypeRef LLVMInt64Type(void);
681 LLVMTypeRef LLVMIntType(unsigned NumBits);
682 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
689 * @defgroup LLVMCCoreTypeFloat Floating Point Types
695 * Obtain a 16-bit floating point type from a context.
697 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
700 * Obtain a 32-bit floating point type from a context.
702 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
705 * Obtain a 64-bit floating point type from a context.
707 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
710 * Obtain a 80-bit floating point type (X87) from a context.
712 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
715 * Obtain a 128-bit floating point type (112-bit mantissa) from a
718 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
721 * Obtain a 128-bit floating point type (two 64-bits) from a context.
723 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
726 * Obtain a floating point type from the global context.
728 * These map to the functions in this group of the same name.
730 LLVMTypeRef LLVMHalfType(void);
731 LLVMTypeRef LLVMFloatType(void);
732 LLVMTypeRef LLVMDoubleType(void);
733 LLVMTypeRef LLVMX86FP80Type(void);
734 LLVMTypeRef LLVMFP128Type(void);
735 LLVMTypeRef LLVMPPCFP128Type(void);
742 * @defgroup LLVMCCoreTypeFunction Function Types
748 * Obtain a function type consisting of a specified signature.
750 * The function is defined as a tuple of a return Type, a list of
751 * parameter types, and whether the function is variadic.
753 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
754 LLVMTypeRef *ParamTypes, unsigned ParamCount,
758 * Returns whether a function type is variadic.
760 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
763 * Obtain the Type this function Type returns.
765 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
768 * Obtain the number of parameters this function accepts.
770 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
773 * Obtain the types of a function's parameters.
775 * The Dest parameter should point to a pre-allocated array of
776 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
777 * first LLVMCountParamTypes() entries in the array will be populated
778 * with LLVMTypeRef instances.
780 * @param FunctionTy The function type to operate on.
781 * @param Dest Memory address of an array to be filled with result.
783 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
790 * @defgroup LLVMCCoreTypeStruct Structure Types
792 * These functions relate to LLVMTypeRef instances.
794 * @see llvm::StructType
800 * Create a new structure type in a context.
802 * A structure is specified by a list of inner elements/types and
803 * whether these can be packed together.
805 * @see llvm::StructType::create()
807 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
808 unsigned ElementCount, LLVMBool Packed);
811 * Create a new structure type in the global context.
813 * @see llvm::StructType::create()
815 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
819 * Create an empty structure in a context having a specified name.
821 * @see llvm::StructType::create()
823 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
826 * Obtain the name of a structure.
828 * @see llvm::StructType::getName()
830 const char *LLVMGetStructName(LLVMTypeRef Ty);
833 * Set the contents of a structure type.
835 * @see llvm::StructType::setBody()
837 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
838 unsigned ElementCount, LLVMBool Packed);
841 * Get the number of elements defined inside the structure.
843 * @see llvm::StructType::getNumElements()
845 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
848 * Get the elements within a structure.
850 * The function is passed the address of a pre-allocated array of
851 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
852 * invocation, this array will be populated with the structure's
853 * elements. The objects in the destination array will have a lifetime
854 * of the structure type itself, which is the lifetime of the context it
857 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
860 * Determine whether a structure is packed.
862 * @see llvm::StructType::isPacked()
864 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
867 * Determine whether a structure is opaque.
869 * @see llvm::StructType::isOpaque()
871 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
879 * @defgroup LLVMCCoreTypeSequential Sequential Types
881 * Sequential types represents "arrays" of types. This is a super class
882 * for array, vector, and pointer types.
888 * Obtain the type of elements within a sequential type.
890 * This works on array, vector, and pointer types.
892 * @see llvm::SequentialType::getElementType()
894 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
897 * Create a fixed size array type that refers to a specific type.
899 * The created type will exist in the context that its element type
902 * @see llvm::ArrayType::get()
904 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
907 * Obtain the length of an array type.
909 * This only works on types that represent arrays.
911 * @see llvm::ArrayType::getNumElements()
913 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
916 * Create a pointer type that points to a defined type.
918 * The created type will exist in the context that its pointee type
921 * @see llvm::PointerType::get()
923 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
926 * Obtain the address space of a pointer type.
928 * This only works on types that represent pointers.
930 * @see llvm::PointerType::getAddressSpace()
932 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
935 * Create a vector type that contains a defined type and has a specific
936 * number of elements.
938 * The created type will exist in the context thats its element type
941 * @see llvm::VectorType::get()
943 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
946 * Obtain the number of elements in a vector type.
948 * This only works on types that represent vectors.
950 * @see llvm::VectorType::getNumElements()
952 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
959 * @defgroup LLVMCCoreTypeOther Other Types
965 * Create a void type in a context.
967 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
970 * Create a label type in a context.
972 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
975 * Create a X86 MMX type in a context.
977 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
980 * These are similar to the above functions except they operate on the
983 LLVMTypeRef LLVMVoidType(void);
984 LLVMTypeRef LLVMLabelType(void);
985 LLVMTypeRef LLVMX86MMXType(void);
996 * @defgroup LLVMCCoreValues Values
998 * The bulk of LLVM's object model consists of values, which comprise a very
999 * rich type hierarchy.
1001 * LLVMValueRef essentially represents llvm::Value. There is a rich
1002 * hierarchy of classes within this type. Depending on the instance
1003 * obtained, not all APIs are available.
1005 * Callers can determine the type of a LLVMValueRef by calling the
1006 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1007 * functions are defined by a macro, so it isn't obvious which are
1008 * available by looking at the Doxygen source code. Instead, look at the
1009 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1010 * of value names given. These value names also correspond to classes in
1011 * the llvm::Value hierarchy.
1016 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1024 macro(BlockAddress) \
1025 macro(ConstantAggregateZero) \
1026 macro(ConstantArray) \
1027 macro(ConstantExpr) \
1029 macro(ConstantInt) \
1030 macro(ConstantPointerNull) \
1031 macro(ConstantStruct) \
1032 macro(ConstantVector) \
1033 macro(GlobalValue) \
1035 macro(GlobalAlias) \
1036 macro(GlobalVariable) \
1038 macro(Instruction) \
1039 macro(BinaryOperator) \
1041 macro(IntrinsicInst) \
1042 macro(DbgInfoIntrinsic) \
1043 macro(DbgDeclareInst) \
1044 macro(MemIntrinsic) \
1046 macro(MemMoveInst) \
1051 macro(ExtractElementInst) \
1052 macro(GetElementPtrInst) \
1053 macro(InsertElementInst) \
1054 macro(InsertValueInst) \
1055 macro(LandingPadInst) \
1058 macro(ShuffleVectorInst) \
1060 macro(TerminatorInst) \
1062 macro(IndirectBrInst) \
1066 macro(UnreachableInst) \
1068 macro(UnaryInstruction) \
1071 macro(BitCastInst) \
1075 macro(FPTruncInst) \
1076 macro(IntToPtrInst) \
1077 macro(PtrToIntInst) \
1083 macro(ExtractValueInst) \
1088 * @defgroup LLVMCCoreValueGeneral General APIs
1090 * Functions in this section work on all LLVMValueRef instances,
1091 * regardless of their sub-type. They correspond to functions available
1098 * Obtain the type of a value.
1100 * @see llvm::Value::getType()
1102 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1105 * Obtain the string name of a value.
1107 * @see llvm::Value::getName()
1109 const char *LLVMGetValueName(LLVMValueRef Val);
1112 * Set the string name of a value.
1114 * @see llvm::Value::setName()
1116 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1119 * Dump a representation of a value to stderr.
1121 * @see llvm::Value::dump()
1123 void LLVMDumpValue(LLVMValueRef Val);
1126 * Replace all uses of a value with another one.
1128 * @see llvm::Value::replaceAllUsesWith()
1130 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1133 * Determine whether the specified constant instance is constant.
1135 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1138 * Determine whether a value instance is undefined.
1140 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1143 * Convert value instances between types.
1145 * Internally, a LLVMValueRef is "pinned" to a specific type. This
1146 * series of functions allows you to cast an instance to a specific
1149 * If the cast is not valid for the specified type, NULL is returned.
1151 * @see llvm::dyn_cast_or_null<>
1153 #define LLVM_DECLARE_VALUE_CAST(name) \
1154 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1155 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1162 * @defgroup LLVMCCoreValueUses Usage
1164 * This module defines functions that allow you to inspect the uses of a
1167 * It is possible to obtain a LLVMUseRef for any LLVMValueRef instance.
1168 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1169 * llvm::User and llvm::Value.
1175 * Obtain the first use of a value.
1177 * Uses are obtained in an iterator fashion. First, call this function
1178 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1179 * on that instance and all subsequently obtained instances until
1180 * LLVMGetNextUse() returns NULL.
1182 * @see llvm::Value::use_begin()
1184 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1187 * Obtain the next use of a value.
1189 * This effectively advances the iterator. It returns NULL if you are on
1190 * the final use and no more are available.
1192 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1195 * Obtain the user value for a user.
1197 * The returned value corresponds to a llvm::User type.
1199 * @see llvm::Use::getUser()
1201 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1204 * Obtain the value this use corresponds to.
1206 * @see llvm::Use::get().
1208 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1215 * @defgroup LLVMCCoreValueUser User value
1217 * Function in this group pertain to LLVMValueRef instances that descent
1218 * from llvm::User. This includes constants, instructions, and
1225 * Obtain an operand at a specific index in a llvm::User value.
1227 * @see llvm::User::getOperand()
1229 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1232 * Set an operand at a specific index in a llvm::User value.
1234 * @see llvm::User::setOperand()
1236 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1239 * Obtain the number of operands in a llvm::User value.
1241 * @see llvm::User::getNumOperands()
1243 int LLVMGetNumOperands(LLVMValueRef Val);
1250 * @defgroup LLVMCCoreValueConstant Constants
1252 * This section contains APIs for interacting with LLVMValueRef that
1253 * correspond to llvm::Constant instances.
1255 * These functions will work for any LLVMValueRef in the llvm::Constant
1262 * Obtain a constant value referring to the null instance of a type.
1264 * @see llvm::Constant::getNullValue()
1266 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1269 * Obtain a constant value referring to the instance of a type
1270 * consisting of all ones.
1272 * This is only valid for integer types.
1274 * @see llvm::Constant::getAllOnesValue()
1276 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1279 * Obtain a constant value referring to an undefined value of a type.
1281 * @see llvm::UndefValue::get()
1283 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1286 * Determine whether a value instance is null.
1288 * @see llvm::Constant::isNullValue()
1290 LLVMBool LLVMIsNull(LLVMValueRef Val);
1293 * Obtain a constant that is a constant pointer pointing to NULL for a
1296 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1299 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1301 * Functions in this group model LLVMValueRef instances that correspond
1302 * to constants referring to scalar types.
1304 * For integer types, the LLVMTypeRef parameter should correspond to a
1305 * llvm::IntegerType instance and the returned LLVMValueRef will
1306 * correspond to a llvm::ConstantInt.
1308 * For floating point types, the LLVMTypeRef returned corresponds to a
1315 * Obtain a constant value for an integer type.
1317 * The returned value corresponds to a llvm::ConstantInt.
1319 * @see llvm::ConstantInt::get()
1321 * @param IntTy Integer type to obtain value of.
1322 * @param N The value the returned instance should refer to.
1323 * @param SignExtend Whether to sign extend the produced value.
1325 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1326 LLVMBool SignExtend);
1329 * Obtain a constant value for an integer of arbitrary precision.
1331 * @see llvm::ConstantInt::get()
1333 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1335 const uint64_t Words[]);
1338 * Obtain a constant value for an integer parsed from a string.
1340 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1341 * string's length is available, it is preferred to call that function
1344 * @see llvm::ConstantInt::get()
1346 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1350 * Obtain a constant value for an integer parsed from a string with
1353 * @see llvm::ConstantInt::get()
1355 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1356 unsigned SLen, uint8_t Radix);
1359 * Obtain a constant value referring to a double floating point value.
1361 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1364 * Obtain a constant for a floating point value parsed from a string.
1366 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1367 * should be used if the input string's length is known.
1369 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1372 * Obtain a constant for a floating point value parsed from a string.
1374 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1378 * Obtain the zero extended value for an integer constant value.
1380 * @see llvm::ConstantInt::getZExtValue()
1382 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1385 * Obtain the sign extended value for an integer constant value.
1387 * @see llvm::ConstantInt::getSExtValue()
1389 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1396 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1398 * Functions in this group operate on composite constants.
1404 * Create a ConstantDataSequential and initialize it with a string.
1406 * @see llvm::ConstantDataArray::getString()
1408 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1409 unsigned Length, LLVMBool DontNullTerminate);
1412 * Create a ConstantDataSequential with string content in the global context.
1414 * This is the same as LLVMConstStringInContext except it operates on the
1417 * @see LLVMConstStringInContext()
1418 * @see llvm::ConstantDataArray::getString()
1420 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1421 LLVMBool DontNullTerminate);
1424 * Create an anonymous ConstantStruct with the specified values.
1426 * @see llvm::ConstantStruct::getAnon()
1428 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1429 LLVMValueRef *ConstantVals,
1430 unsigned Count, LLVMBool Packed);
1433 * Create a ConstantStruct in the global Context.
1435 * This is the same as LLVMConstStructInContext except it operates on the
1438 * @see LLVMConstStructInContext()
1440 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1444 * Create a ConstantArray from values.
1446 * @see llvm::ConstantArray::get()
1448 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1449 LLVMValueRef *ConstantVals, unsigned Length);
1452 * Create a non-anonymous ConstantStruct from values.
1454 * @see llvm::ConstantStruct::get()
1456 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1457 LLVMValueRef *ConstantVals,
1461 * Create a ConstantVector from values.
1463 * @see llvm::ConstantVector::get()
1465 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1472 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1474 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1476 * @see llvm::ConstantExpr.
1480 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1481 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1482 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1483 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1484 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1485 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1486 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1487 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1488 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1489 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1490 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1491 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1492 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1493 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1494 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1495 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1496 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1497 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1498 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1499 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1500 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1501 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1502 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1503 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1504 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1505 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1506 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1507 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1508 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1509 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1510 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1511 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1512 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1513 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1514 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1515 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1516 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1517 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1518 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1519 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1520 LLVMValueRef *ConstantIndices,
1521 unsigned NumIndices);
1522 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1523 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1524 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1525 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1526 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1527 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1528 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1529 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1530 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1531 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1532 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1533 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1534 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1535 LLVMTypeRef ToType);
1536 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1537 LLVMTypeRef ToType);
1538 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1539 LLVMTypeRef ToType);
1540 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1541 LLVMTypeRef ToType);
1542 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1544 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1545 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1546 LLVMValueRef ConstantIfTrue,
1547 LLVMValueRef ConstantIfFalse);
1548 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1549 LLVMValueRef IndexConstant);
1550 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1551 LLVMValueRef ElementValueConstant,
1552 LLVMValueRef IndexConstant);
1553 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1554 LLVMValueRef VectorBConstant,
1555 LLVMValueRef MaskConstant);
1556 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1558 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1559 LLVMValueRef ElementValueConstant,
1560 unsigned *IdxList, unsigned NumIdx);
1561 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1562 const char *AsmString, const char *Constraints,
1563 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1564 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1571 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1573 * This group contains functions that operate on global values. Functions in
1574 * this group relate to functions in the llvm::GlobalValue class tree.
1576 * @see llvm::GlobalValue
1581 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1582 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1583 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1584 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1585 const char *LLVMGetSection(LLVMValueRef Global);
1586 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1587 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1588 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1589 unsigned LLVMGetAlignment(LLVMValueRef Global);
1590 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
1593 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1595 * This group contains functions that operate on global variable values.
1597 * @see llvm::GlobalVariable
1601 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1602 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1604 unsigned AddressSpace);
1605 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1606 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1607 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1608 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1609 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1610 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1611 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1612 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1613 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1614 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1615 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1616 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1617 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1618 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1619 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1620 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1627 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1629 * This group contains function that operate on global alias values.
1631 * @see llvm::GlobalAlias
1635 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1643 * @defgroup LLVMCCoreValueFunction Function values
1645 * Functions in this group operate on LLVMValueRef instances that
1646 * correspond to llvm::Function instances.
1648 * @see llvm::Function
1654 * Remove a function from its containing module and deletes it.
1656 * @see llvm::Function::eraseFromParent()
1658 void LLVMDeleteFunction(LLVMValueRef Fn);
1661 * Obtain the ID number from a function instance.
1663 * @see llvm::Function::getIntrinsicID()
1665 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1668 * Obtain the calling function of a function.
1670 * The returned value corresponds to the LLVMCallConv enumeration.
1672 * @see llvm::Function::getCallingConv()
1674 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1677 * Set the calling convention of a function.
1679 * @see llvm::Function::setCallingConv()
1681 * @param Fn Function to operate on
1682 * @param CC LLVMCallConv to set calling convention to
1684 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1687 * Obtain the name of the garbage collector to use during code
1690 * @see llvm::Function::getGC()
1692 const char *LLVMGetGC(LLVMValueRef Fn);
1695 * Define the garbage collector to use during code generation.
1697 * @see llvm::Function::setGC()
1699 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1702 * Add an attribute to a function.
1704 * @see llvm::Function::addAttribute()
1706 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1709 * Add a target-dependent attribute to a fuction
1710 * @see llvm::AttrBuilder::addAttribute()
1712 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1716 * Obtain an attribute from a function.
1718 * @see llvm::Function::getAttributes()
1720 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1723 * Remove an attribute from a function.
1725 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1728 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1730 * Functions in this group relate to arguments/parameters on functions.
1732 * Functions in this group expect LLVMValueRef instances that correspond
1733 * to llvm::Function instances.
1739 * Obtain the number of parameters in a function.
1741 * @see llvm::Function::arg_size()
1743 unsigned LLVMCountParams(LLVMValueRef Fn);
1746 * Obtain the parameters in a function.
1748 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1749 * at least LLVMCountParams() long. This array will be filled with
1750 * LLVMValueRef instances which correspond to the parameters the
1751 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1754 * @see llvm::Function::arg_begin()
1756 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1759 * Obtain the parameter at the specified index.
1761 * Parameters are indexed from 0.
1763 * @see llvm::Function::arg_begin()
1765 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1768 * Obtain the function to which this argument belongs.
1770 * Unlike other functions in this group, this one takes a LLVMValueRef
1771 * that corresponds to a llvm::Attribute.
1773 * The returned LLVMValueRef is the llvm::Function to which this
1776 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1779 * Obtain the first parameter to a function.
1781 * @see llvm::Function::arg_begin()
1783 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1786 * Obtain the last parameter to a function.
1788 * @see llvm::Function::arg_end()
1790 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
1793 * Obtain the next parameter to a function.
1795 * This takes a LLVMValueRef obtained from LLVMGetFirstParam() (which is
1796 * actually a wrapped iterator) and obtains the next parameter from the
1797 * underlying iterator.
1799 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
1802 * Obtain the previous parameter to a function.
1804 * This is the opposite of LLVMGetNextParam().
1806 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
1809 * Add an attribute to a function argument.
1811 * @see llvm::Argument::addAttr()
1813 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1816 * Remove an attribute from a function argument.
1818 * @see llvm::Argument::removeAttr()
1820 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1823 * Get an attribute from a function argument.
1825 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
1828 * Set the alignment for a function parameter.
1830 * @see llvm::Argument::addAttr()
1831 * @see llvm::AttrBuilder::addAlignmentAttr()
1833 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
1852 * @defgroup LLVMCCoreValueMetadata Metadata
1858 * Obtain a MDString value from a context.
1860 * The returned instance corresponds to the llvm::MDString class.
1862 * The instance is specified by string data of a specified length. The
1863 * string content is copied, so the backing memory can be freed after
1864 * this function returns.
1866 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
1870 * Obtain a MDString value from the global context.
1872 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
1875 * Obtain a MDNode value from a context.
1877 * The returned value corresponds to the llvm::MDNode class.
1879 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
1883 * Obtain a MDNode value from the global context.
1885 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
1888 * Obtain the underlying string from a MDString value.
1890 * @param V Instance to obtain string from.
1891 * @param Len Memory address which will hold length of returned string.
1892 * @return String data in MDString.
1894 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
1897 * Obtain the number of operands from an MDNode value.
1899 * @param V MDNode to get number of operands from.
1900 * @return Number of operands of the MDNode.
1902 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
1905 * Obtain the given MDNode's operands.
1907 * The passed LLVMValueRef pointer should point to enough memory to hold all of
1908 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
1909 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
1910 * MDNode's operands.
1912 * @param V MDNode to get the operands from.
1913 * @param Dest Destination array for operands.
1915 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
1922 * @defgroup LLVMCCoreValueBasicBlock Basic Block
1924 * A basic block represents a single entry single exit section of code.
1925 * Basic blocks contain a list of instructions which form the body of
1928 * Basic blocks belong to functions. They have the type of label.
1930 * Basic blocks are themselves values. However, the C API models them as
1931 * LLVMBasicBlockRef.
1933 * @see llvm::BasicBlock
1939 * Convert a basic block instance to a value type.
1941 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
1944 * Determine whether a LLVMValueRef is itself a basic block.
1946 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
1949 * Convert a LLVMValueRef to a LLVMBasicBlockRef instance.
1951 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
1954 * Obtain the function to which a basic block belongs.
1956 * @see llvm::BasicBlock::getParent()
1958 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
1961 * Obtain the terminator instruction for a basic block.
1963 * If the basic block does not have a terminator (it is not well-formed
1964 * if it doesn't), then NULL is returned.
1966 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
1968 * @see llvm::BasicBlock::getTerminator()
1970 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
1973 * Obtain the number of basic blocks in a function.
1975 * @param Fn Function value to operate on.
1977 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
1980 * Obtain all of the basic blocks in a function.
1982 * This operates on a function value. The BasicBlocks parameter is a
1983 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
1984 * LLVMCountBasicBlocks() in length. This array is populated with
1985 * LLVMBasicBlockRef instances.
1987 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
1990 * Obtain the first basic block in a function.
1992 * The returned basic block can be used as an iterator. You will likely
1993 * eventually call into LLVMGetNextBasicBlock() with it.
1995 * @see llvm::Function::begin()
1997 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2000 * Obtain the last basic block in a function.
2002 * @see llvm::Function::end()
2004 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2007 * Advance a basic block iterator.
2009 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2012 * Go backwards in a basic block iterator.
2014 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2017 * Obtain the basic block that corresponds to the entry point of a
2020 * @see llvm::Function::getEntryBlock()
2022 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2025 * Append a basic block to the end of a function.
2027 * @see llvm::BasicBlock::Create()
2029 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2034 * Append a basic block to the end of a function using the global
2037 * @see llvm::BasicBlock::Create()
2039 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2042 * Insert a basic block in a function before another basic block.
2044 * The function to add to is determined by the function of the
2045 * passed basic block.
2047 * @see llvm::BasicBlock::Create()
2049 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2050 LLVMBasicBlockRef BB,
2054 * Insert a basic block in a function using the global context.
2056 * @see llvm::BasicBlock::Create()
2058 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2062 * Remove a basic block from a function and delete it.
2064 * This deletes the basic block from its containing function and deletes
2065 * the basic block itself.
2067 * @see llvm::BasicBlock::eraseFromParent()
2069 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2072 * Remove a basic block from a function.
2074 * This deletes the basic block from its containing function but keep
2075 * the basic block alive.
2077 * @see llvm::BasicBlock::removeFromParent()
2079 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2082 * Move a basic block to before another one.
2084 * @see llvm::BasicBlock::moveBefore()
2086 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2089 * Move a basic block to after another one.
2091 * @see llvm::BasicBlock::moveAfter()
2093 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2096 * Obtain the first instruction in a basic block.
2098 * The returned LLVMValueRef corresponds to a llvm::Instruction
2101 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2104 * Obtain the last instruction in a basic block.
2106 * The returned LLVMValueRef corresponds to a LLVM:Instruction.
2108 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2115 * @defgroup LLVMCCoreValueInstruction Instructions
2117 * Functions in this group relate to the inspection and manipulation of
2118 * individual instructions.
2120 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2121 * class has a large number of descendents. llvm::Instruction is a
2122 * llvm::Value and in the C API, instructions are modeled by
2125 * This group also contains sub-groups which operate on specific
2126 * llvm::Instruction types, e.g. llvm::CallInst.
2132 * Determine whether an instruction has any metadata attached.
2134 int LLVMHasMetadata(LLVMValueRef Val);
2137 * Return metadata associated with an instruction value.
2139 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2142 * Set metadata associated with an instruction value.
2144 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2147 * Obtain the basic block to which an instruction belongs.
2149 * @see llvm::Instruction::getParent()
2151 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2154 * Obtain the instruction that occurs after the one specified.
2156 * The next instruction will be from the same basic block.
2158 * If this is the last instruction in a basic block, NULL will be
2161 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2164 * Obtain the instruction that occurred before this one.
2166 * If the instruction is the first instruction in a basic block, NULL
2169 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2172 * Remove and delete an instruction.
2174 * The instruction specified is removed from its containing building
2175 * block and then deleted.
2177 * @see llvm::Instruction::eraseFromParent()
2179 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2182 * Obtain the code opcode for an individual instruction.
2184 * @see llvm::Instruction::getOpCode()
2186 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2189 * Obtain the predicate of an instruction.
2191 * This is only valid for instructions that correspond to llvm::ICmpInst
2192 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2194 * @see llvm::ICmpInst::getPredicate()
2196 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2199 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2201 * Functions in this group apply to instructions that refer to call
2202 * sites and invocations. These correspond to C++ types in the
2203 * llvm::CallInst class tree.
2209 * Set the calling convention for a call instruction.
2211 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2214 * @see llvm::CallInst::setCallingConv()
2215 * @see llvm::InvokeInst::setCallingConv()
2217 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2220 * Obtain the calling convention for a call instruction.
2222 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2225 * @see LLVMSetInstructionCallConv()
2227 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2230 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2231 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2233 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2237 * Obtain whether a call instruction is a tail call.
2239 * This only works on llvm::CallInst instructions.
2241 * @see llvm::CallInst::isTailCall()
2243 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2246 * Set whether a call instruction is a tail call.
2248 * This only works on llvm::CallInst instructions.
2250 * @see llvm::CallInst::setTailCall()
2252 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2259 * Obtain the default destination basic block of a switch instruction.
2261 * This only works on llvm::SwitchInst instructions.
2263 * @see llvm::SwitchInst::getDefaultDest()
2265 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2268 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2270 * Functions in this group only apply to instructions that map to
2271 * llvm::PHINode instances.
2277 * Add an incoming value to the end of a PHI list.
2279 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2280 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2283 * Obtain the number of incoming basic blocks to a PHI node.
2285 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2288 * Obtain an incoming value to a PHI node as a LLVMValueRef.
2290 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2293 * Obtain an incoming value to a PHI node as a LLVMBasicBlockRef.
2295 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2310 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2312 * An instruction builder represents a point within a basic block and is
2313 * the exclusive means of building instructions using the C interface.
2318 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2319 LLVMBuilderRef LLVMCreateBuilder(void);
2320 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2321 LLVMValueRef Instr);
2322 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2323 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2324 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2325 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2326 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2327 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2329 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2332 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2333 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2334 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2337 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2338 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2339 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2341 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2342 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2343 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2344 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2345 LLVMBasicBlockRef Else, unsigned NumCases);
2346 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2348 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2349 LLVMValueRef *Args, unsigned NumArgs,
2350 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2352 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2353 LLVMValueRef PersFn, unsigned NumClauses,
2355 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2356 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2358 /* Add a case to the switch instruction */
2359 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2360 LLVMBasicBlockRef Dest);
2362 /* Add a destination to the indirectbr instruction */
2363 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2365 /* Add a catch or filter clause to the landingpad instruction */
2366 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2368 /* Set the 'cleanup' flag in the landingpad instruction */
2369 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2372 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2374 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2376 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2378 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2380 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2382 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2384 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2386 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2388 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2390 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2392 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2394 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2396 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2398 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2400 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2402 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2404 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2406 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2408 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2410 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2412 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2414 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2416 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2418 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2420 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2422 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2423 LLVMValueRef LHS, LLVMValueRef RHS,
2425 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2426 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2428 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2430 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2431 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2434 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2435 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2436 LLVMValueRef Val, const char *Name);
2437 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2438 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2439 LLVMValueRef Val, const char *Name);
2440 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2441 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2443 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2444 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2445 LLVMValueRef *Indices, unsigned NumIndices,
2447 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2448 LLVMValueRef *Indices, unsigned NumIndices,
2450 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2451 unsigned Idx, const char *Name);
2452 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2454 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2456 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2457 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2460 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2461 LLVMTypeRef DestTy, const char *Name);
2462 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2463 LLVMTypeRef DestTy, const char *Name);
2464 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2465 LLVMTypeRef DestTy, const char *Name);
2466 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2467 LLVMTypeRef DestTy, const char *Name);
2468 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2469 LLVMTypeRef DestTy, const char *Name);
2470 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2471 LLVMTypeRef DestTy, const char *Name);
2472 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2473 LLVMTypeRef DestTy, const char *Name);
2474 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2475 LLVMTypeRef DestTy, const char *Name);
2476 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2477 LLVMTypeRef DestTy, const char *Name);
2478 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2479 LLVMTypeRef DestTy, const char *Name);
2480 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2481 LLVMTypeRef DestTy, const char *Name);
2482 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2483 LLVMTypeRef DestTy, const char *Name);
2484 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2485 LLVMTypeRef DestTy, const char *Name);
2486 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2487 LLVMTypeRef DestTy, const char *Name);
2488 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2489 LLVMTypeRef DestTy, const char *Name);
2490 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2491 LLVMTypeRef DestTy, const char *Name);
2492 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2493 LLVMTypeRef DestTy, const char *Name);
2494 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2495 LLVMTypeRef DestTy, const char *Name);
2496 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2497 LLVMTypeRef DestTy, const char *Name);
2500 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2501 LLVMValueRef LHS, LLVMValueRef RHS,
2503 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2504 LLVMValueRef LHS, LLVMValueRef RHS,
2507 /* Miscellaneous instructions */
2508 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2509 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2510 LLVMValueRef *Args, unsigned NumArgs,
2512 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2513 LLVMValueRef Then, LLVMValueRef Else,
2515 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2517 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2518 LLVMValueRef Index, const char *Name);
2519 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2520 LLVMValueRef EltVal, LLVMValueRef Index,
2522 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2523 LLVMValueRef V2, LLVMValueRef Mask,
2525 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2526 unsigned Index, const char *Name);
2527 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2528 LLVMValueRef EltVal, unsigned Index,
2531 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2533 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2535 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2536 LLVMValueRef RHS, const char *Name);
2543 * @defgroup LLVMCCoreModuleProvider Module Providers
2549 * Changes the type of M so it can be passed to FunctionPassManagers and the
2550 * JIT. They take ModuleProviders for historical reasons.
2552 LLVMModuleProviderRef
2553 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2556 * Destroys the module M.
2558 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2565 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2570 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2571 LLVMMemoryBufferRef *OutMemBuf,
2573 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2575 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2576 size_t InputDataLength,
2577 const char *BufferName,
2578 LLVMBool RequiresNullTerminator);
2579 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2580 size_t InputDataLength,
2581 const char *BufferName);
2582 const char* LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2583 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2584 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2591 * @defgroup LLVMCCorePassRegistry Pass Registry
2596 /** Return the global pass registry, for use with initialization functions.
2597 @see llvm::PassRegistry::getPassRegistry */
2598 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2605 * @defgroup LLVMCCorePassManagers Pass Managers
2610 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2611 suitable for link-time optimization and whole-module transformations.
2612 @see llvm::PassManager::PassManager */
2613 LLVMPassManagerRef LLVMCreatePassManager(void);
2615 /** Constructs a new function-by-function pass pipeline over the module
2616 provider. It does not take ownership of the module provider. This type of
2617 pipeline is suitable for code generation and JIT compilation tasks.
2618 @see llvm::FunctionPassManager::FunctionPassManager */
2619 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2621 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2622 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2624 /** Initializes, executes on the provided module, and finalizes all of the
2625 passes scheduled in the pass manager. Returns 1 if any of the passes
2626 modified the module, 0 otherwise.
2627 @see llvm::PassManager::run(Module&) */
2628 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2630 /** Initializes all of the function passes scheduled in the function pass
2631 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2632 @see llvm::FunctionPassManager::doInitialization */
2633 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2635 /** Executes all of the function passes scheduled in the function pass manager
2636 on the provided function. Returns 1 if any of the passes modified the
2637 function, false otherwise.
2638 @see llvm::FunctionPassManager::run(Function&) */
2639 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2641 /** Finalizes all of the function passes scheduled in in the function pass
2642 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2643 @see llvm::FunctionPassManager::doFinalization */
2644 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2646 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2647 the module provider.
2648 @see llvm::PassManagerBase::~PassManagerBase. */
2649 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2656 * @defgroup LLVMCCoreThreading Threading
2658 * Handle the structures needed to make LLVM safe for multithreading.
2663 /** Allocate and initialize structures needed to make LLVM safe for
2664 multithreading. The return value indicates whether multithreaded
2665 initialization succeeded. Must be executed in isolation from all
2666 other LLVM api calls.
2667 @see llvm::llvm_start_multithreaded */
2668 LLVMBool LLVMStartMultithreaded();
2670 /** Deallocate structures necessary to make LLVM safe for multithreading.
2671 Must be executed in isolation from all other LLVM api calls.
2672 @see llvm::llvm_stop_multithreaded */
2673 void LLVMStopMultithreaded();
2675 /** Check whether LLVM is executing in thread-safe mode or not.
2676 @see llvm::llvm_is_multithreaded */
2677 LLVMBool LLVMIsMultithreaded();
2696 class PassManagerBase;
2698 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
2699 inline ty *unwrap(ref P) { \
2700 return reinterpret_cast<ty*>(P); \
2703 inline ref wrap(const ty *P) { \
2704 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
2707 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
2708 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
2710 template<typename T> \
2711 inline T *unwrap(ref P) { \
2712 return cast<T>(unwrap(P)); \
2715 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
2716 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
2718 template<typename T> \
2719 inline T *unwrap(ref P) { \
2720 T *Q = (T*)unwrap(P); \
2721 assert(Q && "Invalid cast!"); \
2725 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
2726 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
2727 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
2728 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
2729 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
2730 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
2731 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
2732 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
2733 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
2734 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
2735 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
2738 inline Module *unwrap(LLVMModuleProviderRef MP) {
2739 return reinterpret_cast<Module*>(MP);
2742 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
2743 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
2744 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
2746 /* Specialized opaque context conversions.
2748 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
2749 return reinterpret_cast<LLVMContext**>(Tys);
2752 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
2753 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
2756 /* Specialized opaque type conversions.
2758 inline Type **unwrap(LLVMTypeRef* Tys) {
2759 return reinterpret_cast<Type**>(Tys);
2762 inline LLVMTypeRef *wrap(Type **Tys) {
2763 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
2766 /* Specialized opaque value conversions.
2768 inline Value **unwrap(LLVMValueRef *Vals) {
2769 return reinterpret_cast<Value**>(Vals);
2772 template<typename T>
2773 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
2775 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
2779 return reinterpret_cast<T**>(Vals);
2782 inline LLVMValueRef *wrap(const Value **Vals) {
2783 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
2787 #endif /* !defined(__cplusplus) */
2789 #endif /* !defined(LLVM_C_CORE_H) */