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;
359 void LLVMInitializeCore(LLVMPassRegistryRef R);
362 /*===-- Error handling ----------------------------------------------------===*/
364 void LLVMDisposeMessage(char *Message);
368 * @defgroup LLVMCCoreContext Contexts
370 * Contexts are execution states for the core LLVM IR system.
372 * Most types are tied to a context instance. Multiple contexts can
373 * exist simultaneously. A single context is not thread safe. However,
374 * different contexts can execute on different threads simultaneously.
380 * Create a new context.
382 * Every call to this function should be paired with a call to
383 * LLVMContextDispose() or the context will leak memory.
385 LLVMContextRef LLVMContextCreate(void);
388 * Obtain the global context instance.
390 LLVMContextRef LLVMGetGlobalContext(void);
393 * Destroy a context instance.
395 * This should be called for every call to LLVMContextCreate() or memory
398 void LLVMContextDispose(LLVMContextRef C);
400 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
402 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
409 * @defgroup LLVMCCoreModule Modules
411 * Modules represent the top-level structure in a LLVM program. An LLVM
412 * module is effectively a translation unit or a collection of
413 * translation units merged together.
419 * Create a new, empty module in the global context.
421 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
422 * LLVMGetGlobalContext() as the context parameter.
424 * Every invocation should be paired with LLVMDisposeModule() or memory
427 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
430 * Create a new, empty module in a specific context.
432 * Every invocation should be paired with LLVMDisposeModule() or memory
435 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
439 * Destroy a module instance.
441 * This must be called for every created module or memory will be
444 void LLVMDisposeModule(LLVMModuleRef M);
447 * Obtain the data layout for a module.
449 * @see Module::getDataLayout()
451 const char *LLVMGetDataLayout(LLVMModuleRef M);
454 * Set the data layout for a module.
456 * @see Module::setDataLayout()
458 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
461 * Obtain the target triple for a module.
463 * @see Module::getTargetTriple()
465 const char *LLVMGetTarget(LLVMModuleRef M);
468 * Set the target triple for a module.
470 * @see Module::setTargetTriple()
472 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
475 * Dump a representation of a module to stderr.
477 * @see Module::dump()
479 void LLVMDumpModule(LLVMModuleRef M);
482 * Print a representation of a module to a file. The ErrorMessage needs to be
483 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
485 * @see Module::print()
487 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
488 char **ErrorMessage);
491 * Set inline assembly for a module.
493 * @see Module::setModuleInlineAsm()
495 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
498 * Obtain the context to which this module is associated.
500 * @see Module::getContext()
502 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
505 * Obtain a Type from a module by its registered name.
507 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
510 * Obtain the number of operands for named metadata in a module.
512 * @see llvm::Module::getNamedMetadata()
514 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
517 * Obtain the named metadata operands for a module.
519 * The passed LLVMValueRef pointer should refer to an array of
520 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
521 * array will be populated with the LLVMValueRef instances. Each
522 * instance corresponds to a llvm::MDNode.
524 * @see llvm::Module::getNamedMetadata()
525 * @see llvm::MDNode::getOperand()
527 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
530 * Add an operand to named metadata.
532 * @see llvm::Module::getNamedMetadata()
533 * @see llvm::MDNode::addOperand()
535 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
539 * Add a function to a module under a specified name.
541 * @see llvm::Function::Create()
543 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
544 LLVMTypeRef FunctionTy);
547 * Obtain a Function value from a Module by its name.
549 * The returned value corresponds to a llvm::Function value.
551 * @see llvm::Module::getFunction()
553 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
556 * Obtain an iterator to the first Function in a Module.
558 * @see llvm::Module::begin()
560 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
563 * Obtain an iterator to the last Function in a Module.
565 * @see llvm::Module::end()
567 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
570 * Advance a Function iterator to the next Function.
572 * Returns NULL if the iterator was already at the end and there are no more
575 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
578 * Decrement a Function iterator to the previous Function.
580 * Returns NULL if the iterator was already at the beginning and there are
581 * no previous functions.
583 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
590 * @defgroup LLVMCCoreType Types
592 * Types represent the type of a value.
594 * Types are associated with a context instance. The context internally
595 * deduplicates types so there is only 1 instance of a specific type
596 * alive at a time. In other words, a unique type is shared among all
597 * consumers within a context.
599 * A Type in the C API corresponds to llvm::Type.
601 * Types have the following hierarchy:
619 * Obtain the enumerated type of a Type instance.
621 * @see llvm::Type:getTypeID()
623 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
626 * Whether the type has a known size.
628 * Things that don't have a size are abstract types, labels, and void.a
630 * @see llvm::Type::isSized()
632 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
635 * Obtain the context to which this type instance is associated.
637 * @see llvm::Type::getContext()
639 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
642 * @defgroup LLVMCCoreTypeInt Integer Types
644 * Functions in this section operate on integer types.
650 * Obtain an integer type from a context with specified bit width.
652 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
653 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
654 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
655 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
656 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
657 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
660 * Obtain an integer type from the global context with a specified bit
663 LLVMTypeRef LLVMInt1Type(void);
664 LLVMTypeRef LLVMInt8Type(void);
665 LLVMTypeRef LLVMInt16Type(void);
666 LLVMTypeRef LLVMInt32Type(void);
667 LLVMTypeRef LLVMInt64Type(void);
668 LLVMTypeRef LLVMIntType(unsigned NumBits);
669 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
676 * @defgroup LLVMCCoreTypeFloat Floating Point Types
682 * Obtain a 16-bit floating point type from a context.
684 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
687 * Obtain a 32-bit floating point type from a context.
689 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
692 * Obtain a 64-bit floating point type from a context.
694 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
697 * Obtain a 80-bit floating point type (X87) from a context.
699 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
702 * Obtain a 128-bit floating point type (112-bit mantissa) from a
705 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
708 * Obtain a 128-bit floating point type (two 64-bits) from a context.
710 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
713 * Obtain a floating point type from the global context.
715 * These map to the functions in this group of the same name.
717 LLVMTypeRef LLVMHalfType(void);
718 LLVMTypeRef LLVMFloatType(void);
719 LLVMTypeRef LLVMDoubleType(void);
720 LLVMTypeRef LLVMX86FP80Type(void);
721 LLVMTypeRef LLVMFP128Type(void);
722 LLVMTypeRef LLVMPPCFP128Type(void);
729 * @defgroup LLVMCCoreTypeFunction Function Types
735 * Obtain a function type consisting of a specified signature.
737 * The function is defined as a tuple of a return Type, a list of
738 * parameter types, and whether the function is variadic.
740 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
741 LLVMTypeRef *ParamTypes, unsigned ParamCount,
745 * Returns whether a function type is variadic.
747 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
750 * Obtain the Type this function Type returns.
752 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
755 * Obtain the number of parameters this function accepts.
757 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
760 * Obtain the types of a function's parameters.
762 * The Dest parameter should point to a pre-allocated array of
763 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
764 * first LLVMCountParamTypes() entries in the array will be populated
765 * with LLVMTypeRef instances.
767 * @param FunctionTy The function type to operate on.
768 * @param Dest Memory address of an array to be filled with result.
770 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
777 * @defgroup LLVMCCoreTypeStruct Structure Types
779 * These functions relate to LLVMTypeRef instances.
781 * @see llvm::StructType
787 * Create a new structure type in a context.
789 * A structure is specified by a list of inner elements/types and
790 * whether these can be packed together.
792 * @see llvm::StructType::create()
794 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
795 unsigned ElementCount, LLVMBool Packed);
798 * Create a new structure type in the global context.
800 * @see llvm::StructType::create()
802 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
806 * Create an empty structure in a context having a specified name.
808 * @see llvm::StructType::create()
810 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
813 * Obtain the name of a structure.
815 * @see llvm::StructType::getName()
817 const char *LLVMGetStructName(LLVMTypeRef Ty);
820 * Set the contents of a structure type.
822 * @see llvm::StructType::setBody()
824 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
825 unsigned ElementCount, LLVMBool Packed);
828 * Get the number of elements defined inside the structure.
830 * @see llvm::StructType::getNumElements()
832 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
835 * Get the elements within a structure.
837 * The function is passed the address of a pre-allocated array of
838 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
839 * invocation, this array will be populated with the structure's
840 * elements. The objects in the destination array will have a lifetime
841 * of the structure type itself, which is the lifetime of the context it
844 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
847 * Determine whether a structure is packed.
849 * @see llvm::StructType::isPacked()
851 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
854 * Determine whether a structure is opaque.
856 * @see llvm::StructType::isOpaque()
858 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
866 * @defgroup LLVMCCoreTypeSequential Sequential Types
868 * Sequential types represents "arrays" of types. This is a super class
869 * for array, vector, and pointer types.
875 * Obtain the type of elements within a sequential type.
877 * This works on array, vector, and pointer types.
879 * @see llvm::SequentialType::getElementType()
881 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
884 * Create a fixed size array type that refers to a specific type.
886 * The created type will exist in the context that its element type
889 * @see llvm::ArrayType::get()
891 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
894 * Obtain the length of an array type.
896 * This only works on types that represent arrays.
898 * @see llvm::ArrayType::getNumElements()
900 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
903 * Create a pointer type that points to a defined type.
905 * The created type will exist in the context that its pointee type
908 * @see llvm::PointerType::get()
910 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
913 * Obtain the address space of a pointer type.
915 * This only works on types that represent pointers.
917 * @see llvm::PointerType::getAddressSpace()
919 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
922 * Create a vector type that contains a defined type and has a specific
923 * number of elements.
925 * The created type will exist in the context thats its element type
928 * @see llvm::VectorType::get()
930 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
933 * Obtain the number of elements in a vector type.
935 * This only works on types that represent vectors.
937 * @see llvm::VectorType::getNumElements()
939 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
946 * @defgroup LLVMCCoreTypeOther Other Types
952 * Create a void type in a context.
954 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
957 * Create a label type in a context.
959 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
962 * Create a X86 MMX type in a context.
964 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
967 * These are similar to the above functions except they operate on the
970 LLVMTypeRef LLVMVoidType(void);
971 LLVMTypeRef LLVMLabelType(void);
972 LLVMTypeRef LLVMX86MMXType(void);
983 * @defgroup LLVMCCoreValues Values
985 * The bulk of LLVM's object model consists of values, which comprise a very
986 * rich type hierarchy.
988 * LLVMValueRef essentially represents llvm::Value. There is a rich
989 * hierarchy of classes within this type. Depending on the instance
990 * obtained, not all APIs are available.
992 * Callers can determine the type of a LLVMValueRef by calling the
993 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
994 * functions are defined by a macro, so it isn't obvious which are
995 * available by looking at the Doxygen source code. Instead, look at the
996 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
997 * of value names given. These value names also correspond to classes in
998 * the llvm::Value hierarchy.
1003 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1011 macro(BlockAddress) \
1012 macro(ConstantAggregateZero) \
1013 macro(ConstantArray) \
1014 macro(ConstantExpr) \
1016 macro(ConstantInt) \
1017 macro(ConstantPointerNull) \
1018 macro(ConstantStruct) \
1019 macro(ConstantVector) \
1020 macro(GlobalValue) \
1022 macro(GlobalAlias) \
1023 macro(GlobalVariable) \
1025 macro(Instruction) \
1026 macro(BinaryOperator) \
1028 macro(IntrinsicInst) \
1029 macro(DbgInfoIntrinsic) \
1030 macro(DbgDeclareInst) \
1031 macro(MemIntrinsic) \
1033 macro(MemMoveInst) \
1038 macro(ExtractElementInst) \
1039 macro(GetElementPtrInst) \
1040 macro(InsertElementInst) \
1041 macro(InsertValueInst) \
1042 macro(LandingPadInst) \
1045 macro(ShuffleVectorInst) \
1047 macro(TerminatorInst) \
1049 macro(IndirectBrInst) \
1053 macro(UnreachableInst) \
1055 macro(UnaryInstruction) \
1058 macro(BitCastInst) \
1062 macro(FPTruncInst) \
1063 macro(IntToPtrInst) \
1064 macro(PtrToIntInst) \
1070 macro(ExtractValueInst) \
1075 * @defgroup LLVMCCoreValueGeneral General APIs
1077 * Functions in this section work on all LLVMValueRef instances,
1078 * regardless of their sub-type. They correspond to functions available
1085 * Obtain the type of a value.
1087 * @see llvm::Value::getType()
1089 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1092 * Obtain the string name of a value.
1094 * @see llvm::Value::getName()
1096 const char *LLVMGetValueName(LLVMValueRef Val);
1099 * Set the string name of a value.
1101 * @see llvm::Value::setName()
1103 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1106 * Dump a representation of a value to stderr.
1108 * @see llvm::Value::dump()
1110 void LLVMDumpValue(LLVMValueRef Val);
1113 * Replace all uses of a value with another one.
1115 * @see llvm::Value::replaceAllUsesWith()
1117 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1120 * Determine whether the specified constant instance is constant.
1122 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1125 * Determine whether a value instance is undefined.
1127 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1130 * Convert value instances between types.
1132 * Internally, a LLVMValueRef is "pinned" to a specific type. This
1133 * series of functions allows you to cast an instance to a specific
1136 * If the cast is not valid for the specified type, NULL is returned.
1138 * @see llvm::dyn_cast_or_null<>
1140 #define LLVM_DECLARE_VALUE_CAST(name) \
1141 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1142 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1149 * @defgroup LLVMCCoreValueUses Usage
1151 * This module defines functions that allow you to inspect the uses of a
1154 * It is possible to obtain a LLVMUseRef for any LLVMValueRef instance.
1155 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1156 * llvm::User and llvm::Value.
1162 * Obtain the first use of a value.
1164 * Uses are obtained in an iterator fashion. First, call this function
1165 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1166 * on that instance and all subsequently obtained instances until
1167 * LLVMGetNextUse() returns NULL.
1169 * @see llvm::Value::use_begin()
1171 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1174 * Obtain the next use of a value.
1176 * This effectively advances the iterator. It returns NULL if you are on
1177 * the final use and no more are available.
1179 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1182 * Obtain the user value for a user.
1184 * The returned value corresponds to a llvm::User type.
1186 * @see llvm::Use::getUser()
1188 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1191 * Obtain the value this use corresponds to.
1193 * @see llvm::Use::get().
1195 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1202 * @defgroup LLVMCCoreValueUser User value
1204 * Function in this group pertain to LLVMValueRef instances that descent
1205 * from llvm::User. This includes constants, instructions, and
1212 * Obtain an operand at a specific index in a llvm::User value.
1214 * @see llvm::User::getOperand()
1216 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1219 * Set an operand at a specific index in a llvm::User value.
1221 * @see llvm::User::setOperand()
1223 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1226 * Obtain the number of operands in a llvm::User value.
1228 * @see llvm::User::getNumOperands()
1230 int LLVMGetNumOperands(LLVMValueRef Val);
1237 * @defgroup LLVMCCoreValueConstant Constants
1239 * This section contains APIs for interacting with LLVMValueRef that
1240 * correspond to llvm::Constant instances.
1242 * These functions will work for any LLVMValueRef in the llvm::Constant
1249 * Obtain a constant value referring to the null instance of a type.
1251 * @see llvm::Constant::getNullValue()
1253 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1256 * Obtain a constant value referring to the instance of a type
1257 * consisting of all ones.
1259 * This is only valid for integer types.
1261 * @see llvm::Constant::getAllOnesValue()
1263 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1266 * Obtain a constant value referring to an undefined value of a type.
1268 * @see llvm::UndefValue::get()
1270 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1273 * Determine whether a value instance is null.
1275 * @see llvm::Constant::isNullValue()
1277 LLVMBool LLVMIsNull(LLVMValueRef Val);
1280 * Obtain a constant that is a constant pointer pointing to NULL for a
1283 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1286 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1288 * Functions in this group model LLVMValueRef instances that correspond
1289 * to constants referring to scalar types.
1291 * For integer types, the LLVMTypeRef parameter should correspond to a
1292 * llvm::IntegerType instance and the returned LLVMValueRef will
1293 * correspond to a llvm::ConstantInt.
1295 * For floating point types, the LLVMTypeRef returned corresponds to a
1302 * Obtain a constant value for an integer type.
1304 * The returned value corresponds to a llvm::ConstantInt.
1306 * @see llvm::ConstantInt::get()
1308 * @param IntTy Integer type to obtain value of.
1309 * @param N The value the returned instance should refer to.
1310 * @param SignExtend Whether to sign extend the produced value.
1312 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1313 LLVMBool SignExtend);
1316 * Obtain a constant value for an integer of arbitrary precision.
1318 * @see llvm::ConstantInt::get()
1320 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1322 const uint64_t Words[]);
1325 * Obtain a constant value for an integer parsed from a string.
1327 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1328 * string's length is available, it is preferred to call that function
1331 * @see llvm::ConstantInt::get()
1333 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1337 * Obtain a constant value for an integer parsed from a string with
1340 * @see llvm::ConstantInt::get()
1342 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1343 unsigned SLen, uint8_t Radix);
1346 * Obtain a constant value referring to a double floating point value.
1348 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1351 * Obtain a constant for a floating point value parsed from a string.
1353 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1354 * should be used if the input string's length is known.
1356 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1359 * Obtain a constant for a floating point value parsed from a string.
1361 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1365 * Obtain the zero extended value for an integer constant value.
1367 * @see llvm::ConstantInt::getZExtValue()
1369 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1372 * Obtain the sign extended value for an integer constant value.
1374 * @see llvm::ConstantInt::getSExtValue()
1376 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1383 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1385 * Functions in this group operate on composite constants.
1391 * Create a ConstantDataSequential and initialize it with a string.
1393 * @see llvm::ConstantDataArray::getString()
1395 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1396 unsigned Length, LLVMBool DontNullTerminate);
1399 * Create a ConstantDataSequential with string content in the global context.
1401 * This is the same as LLVMConstStringInContext except it operates on the
1404 * @see LLVMConstStringInContext()
1405 * @see llvm::ConstantDataArray::getString()
1407 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1408 LLVMBool DontNullTerminate);
1411 * Create an anonymous ConstantStruct with the specified values.
1413 * @see llvm::ConstantStruct::getAnon()
1415 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1416 LLVMValueRef *ConstantVals,
1417 unsigned Count, LLVMBool Packed);
1420 * Create a ConstantStruct in the global Context.
1422 * This is the same as LLVMConstStructInContext except it operates on the
1425 * @see LLVMConstStructInContext()
1427 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1431 * Create a ConstantArray from values.
1433 * @see llvm::ConstantArray::get()
1435 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1436 LLVMValueRef *ConstantVals, unsigned Length);
1439 * Create a non-anonymous ConstantStruct from values.
1441 * @see llvm::ConstantStruct::get()
1443 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1444 LLVMValueRef *ConstantVals,
1448 * Create a ConstantVector from values.
1450 * @see llvm::ConstantVector::get()
1452 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1459 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1461 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1463 * @see llvm::ConstantExpr.
1467 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1468 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1469 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1470 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1471 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1472 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1473 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1474 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1475 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1476 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1477 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1478 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1479 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1480 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1481 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1482 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1483 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1484 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1485 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1486 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1487 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1488 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1489 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1490 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1491 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1492 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1493 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1494 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1495 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1496 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1497 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1498 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1499 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1500 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1501 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1502 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1503 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1504 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1505 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1506 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1507 LLVMValueRef *ConstantIndices,
1508 unsigned NumIndices);
1509 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1510 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1511 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1512 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1513 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1514 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1515 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1516 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1517 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1518 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1519 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1520 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1521 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1522 LLVMTypeRef ToType);
1523 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1524 LLVMTypeRef ToType);
1525 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1526 LLVMTypeRef ToType);
1527 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1528 LLVMTypeRef ToType);
1529 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1531 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1532 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1533 LLVMValueRef ConstantIfTrue,
1534 LLVMValueRef ConstantIfFalse);
1535 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1536 LLVMValueRef IndexConstant);
1537 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1538 LLVMValueRef ElementValueConstant,
1539 LLVMValueRef IndexConstant);
1540 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1541 LLVMValueRef VectorBConstant,
1542 LLVMValueRef MaskConstant);
1543 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1545 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1546 LLVMValueRef ElementValueConstant,
1547 unsigned *IdxList, unsigned NumIdx);
1548 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1549 const char *AsmString, const char *Constraints,
1550 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1551 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1558 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1560 * This group contains functions that operate on global values. Functions in
1561 * this group relate to functions in the llvm::GlobalValue class tree.
1563 * @see llvm::GlobalValue
1568 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1569 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1570 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1571 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1572 const char *LLVMGetSection(LLVMValueRef Global);
1573 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1574 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1575 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1576 unsigned LLVMGetAlignment(LLVMValueRef Global);
1577 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
1580 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1582 * This group contains functions that operate on global variable values.
1584 * @see llvm::GlobalVariable
1588 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1589 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1591 unsigned AddressSpace);
1592 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1593 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1594 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1595 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1596 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1597 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1598 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1599 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1600 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1601 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1602 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1603 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1610 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1612 * This group contains function that operate on global alias values.
1614 * @see llvm::GlobalAlias
1618 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1626 * @defgroup LLVMCCoreValueFunction Function values
1628 * Functions in this group operate on LLVMValueRef instances that
1629 * correspond to llvm::Function instances.
1631 * @see llvm::Function
1637 * Remove a function from its containing module and deletes it.
1639 * @see llvm::Function::eraseFromParent()
1641 void LLVMDeleteFunction(LLVMValueRef Fn);
1644 * Obtain the ID number from a function instance.
1646 * @see llvm::Function::getIntrinsicID()
1648 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1651 * Obtain the calling function of a function.
1653 * The returned value corresponds to the LLVMCallConv enumeration.
1655 * @see llvm::Function::getCallingConv()
1657 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1660 * Set the calling convention of a function.
1662 * @see llvm::Function::setCallingConv()
1664 * @param Fn Function to operate on
1665 * @param CC LLVMCallConv to set calling convention to
1667 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1670 * Obtain the name of the garbage collector to use during code
1673 * @see llvm::Function::getGC()
1675 const char *LLVMGetGC(LLVMValueRef Fn);
1678 * Define the garbage collector to use during code generation.
1680 * @see llvm::Function::setGC()
1682 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1685 * Add an attribute to a function.
1687 * @see llvm::Function::addAttribute()
1689 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1692 * Obtain an attribute from a function.
1694 * @see llvm::Function::getAttributes()
1696 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1699 * Remove an attribute from a function.
1701 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1704 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1706 * Functions in this group relate to arguments/parameters on functions.
1708 * Functions in this group expect LLVMValueRef instances that correspond
1709 * to llvm::Function instances.
1715 * Obtain the number of parameters in a function.
1717 * @see llvm::Function::arg_size()
1719 unsigned LLVMCountParams(LLVMValueRef Fn);
1722 * Obtain the parameters in a function.
1724 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1725 * at least LLVMCountParams() long. This array will be filled with
1726 * LLVMValueRef instances which correspond to the parameters the
1727 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1730 * @see llvm::Function::arg_begin()
1732 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1735 * Obtain the parameter at the specified index.
1737 * Parameters are indexed from 0.
1739 * @see llvm::Function::arg_begin()
1741 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1744 * Obtain the function to which this argument belongs.
1746 * Unlike other functions in this group, this one takes a LLVMValueRef
1747 * that corresponds to a llvm::Attribute.
1749 * The returned LLVMValueRef is the llvm::Function to which this
1752 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1755 * Obtain the first parameter to a function.
1757 * @see llvm::Function::arg_begin()
1759 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1762 * Obtain the last parameter to a function.
1764 * @see llvm::Function::arg_end()
1766 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
1769 * Obtain the next parameter to a function.
1771 * This takes a LLVMValueRef obtained from LLVMGetFirstParam() (which is
1772 * actually a wrapped iterator) and obtains the next parameter from the
1773 * underlying iterator.
1775 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
1778 * Obtain the previous parameter to a function.
1780 * This is the opposite of LLVMGetNextParam().
1782 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
1785 * Add an attribute to a function argument.
1787 * @see llvm::Argument::addAttr()
1789 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1792 * Remove an attribute from a function argument.
1794 * @see llvm::Argument::removeAttr()
1796 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1799 * Get an attribute from a function argument.
1801 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
1804 * Set the alignment for a function parameter.
1806 * @see llvm::Argument::addAttr()
1807 * @see llvm::AttrBuilder::addAlignmentAttr()
1809 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
1828 * @defgroup LLVMCCoreValueMetadata Metadata
1834 * Obtain a MDString value from a context.
1836 * The returned instance corresponds to the llvm::MDString class.
1838 * The instance is specified by string data of a specified length. The
1839 * string content is copied, so the backing memory can be freed after
1840 * this function returns.
1842 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
1846 * Obtain a MDString value from the global context.
1848 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
1851 * Obtain a MDNode value from a context.
1853 * The returned value corresponds to the llvm::MDNode class.
1855 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
1859 * Obtain a MDNode value from the global context.
1861 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
1864 * Obtain the underlying string from a MDString value.
1866 * @param V Instance to obtain string from.
1867 * @param Len Memory address which will hold length of returned string.
1868 * @return String data in MDString.
1870 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
1873 * Obtain the number of operands from an MDNode value.
1875 * @param V MDNode to get number of operands from.
1876 * @return Number of operands of the MDNode.
1878 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
1881 * Obtain the given MDNode's operands.
1883 * The passed LLVMValueRef pointer should point to enough memory to hold all of
1884 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
1885 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
1886 * MDNode's operands.
1888 * @param V MDNode to get the operands from.
1889 * @param Dest Destination array for operands.
1891 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
1898 * @defgroup LLVMCCoreValueBasicBlock Basic Block
1900 * A basic block represents a single entry single exit section of code.
1901 * Basic blocks contain a list of instructions which form the body of
1904 * Basic blocks belong to functions. They have the type of label.
1906 * Basic blocks are themselves values. However, the C API models them as
1907 * LLVMBasicBlockRef.
1909 * @see llvm::BasicBlock
1915 * Convert a basic block instance to a value type.
1917 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
1920 * Determine whether a LLVMValueRef is itself a basic block.
1922 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
1925 * Convert a LLVMValueRef to a LLVMBasicBlockRef instance.
1927 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
1930 * Obtain the function to which a basic block belongs.
1932 * @see llvm::BasicBlock::getParent()
1934 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
1937 * Obtain the terminator instruction for a basic block.
1939 * If the basic block does not have a terminator (it is not well-formed
1940 * if it doesn't), then NULL is returned.
1942 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
1944 * @see llvm::BasicBlock::getTerminator()
1946 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
1949 * Obtain the number of basic blocks in a function.
1951 * @param Fn Function value to operate on.
1953 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
1956 * Obtain all of the basic blocks in a function.
1958 * This operates on a function value. The BasicBlocks parameter is a
1959 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
1960 * LLVMCountBasicBlocks() in length. This array is populated with
1961 * LLVMBasicBlockRef instances.
1963 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
1966 * Obtain the first basic block in a function.
1968 * The returned basic block can be used as an iterator. You will likely
1969 * eventually call into LLVMGetNextBasicBlock() with it.
1971 * @see llvm::Function::begin()
1973 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
1976 * Obtain the last basic block in a function.
1978 * @see llvm::Function::end()
1980 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
1983 * Advance a basic block iterator.
1985 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
1988 * Go backwards in a basic block iterator.
1990 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
1993 * Obtain the basic block that corresponds to the entry point of a
1996 * @see llvm::Function::getEntryBlock()
1998 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2001 * Append a basic block to the end of a function.
2003 * @see llvm::BasicBlock::Create()
2005 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2010 * Append a basic block to the end of a function using the global
2013 * @see llvm::BasicBlock::Create()
2015 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2018 * Insert a basic block in a function before another basic block.
2020 * The function to add to is determined by the function of the
2021 * passed basic block.
2023 * @see llvm::BasicBlock::Create()
2025 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2026 LLVMBasicBlockRef BB,
2030 * Insert a basic block in a function using the global context.
2032 * @see llvm::BasicBlock::Create()
2034 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2038 * Remove a basic block from a function and delete it.
2040 * This deletes the basic block from its containing function and deletes
2041 * the basic block itself.
2043 * @see llvm::BasicBlock::eraseFromParent()
2045 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2048 * Remove a basic block from a function.
2050 * This deletes the basic block from its containing function but keep
2051 * the basic block alive.
2053 * @see llvm::BasicBlock::removeFromParent()
2055 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2058 * Move a basic block to before another one.
2060 * @see llvm::BasicBlock::moveBefore()
2062 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2065 * Move a basic block to after another one.
2067 * @see llvm::BasicBlock::moveAfter()
2069 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2072 * Obtain the first instruction in a basic block.
2074 * The returned LLVMValueRef corresponds to a llvm::Instruction
2077 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2080 * Obtain the last instruction in a basic block.
2082 * The returned LLVMValueRef corresponds to a LLVM:Instruction.
2084 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2091 * @defgroup LLVMCCoreValueInstruction Instructions
2093 * Functions in this group relate to the inspection and manipulation of
2094 * individual instructions.
2096 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2097 * class has a large number of descendents. llvm::Instruction is a
2098 * llvm::Value and in the C API, instructions are modeled by
2101 * This group also contains sub-groups which operate on specific
2102 * llvm::Instruction types, e.g. llvm::CallInst.
2108 * Determine whether an instruction has any metadata attached.
2110 int LLVMHasMetadata(LLVMValueRef Val);
2113 * Return metadata associated with an instruction value.
2115 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2118 * Set metadata associated with an instruction value.
2120 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2123 * Obtain the basic block to which an instruction belongs.
2125 * @see llvm::Instruction::getParent()
2127 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2130 * Obtain the instruction that occurs after the one specified.
2132 * The next instruction will be from the same basic block.
2134 * If this is the last instruction in a basic block, NULL will be
2137 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2140 * Obtain the instruction that occurred before this one.
2142 * If the instruction is the first instruction in a basic block, NULL
2145 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2148 * Remove and delete an instruction.
2150 * The instruction specified is removed from its containing building
2151 * block and then deleted.
2153 * @see llvm::Instruction::eraseFromParent()
2155 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2158 * Obtain the code opcode for an individual instruction.
2160 * @see llvm::Instruction::getOpCode()
2162 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2165 * Obtain the predicate of an instruction.
2167 * This is only valid for instructions that correspond to llvm::ICmpInst
2168 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2170 * @see llvm::ICmpInst::getPredicate()
2172 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2175 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2177 * Functions in this group apply to instructions that refer to call
2178 * sites and invocations. These correspond to C++ types in the
2179 * llvm::CallInst class tree.
2185 * Set the calling convention for a call instruction.
2187 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2190 * @see llvm::CallInst::setCallingConv()
2191 * @see llvm::InvokeInst::setCallingConv()
2193 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2196 * Obtain the calling convention for a call instruction.
2198 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2201 * @see LLVMSetInstructionCallConv()
2203 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2206 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2207 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2209 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2213 * Obtain whether a call instruction is a tail call.
2215 * This only works on llvm::CallInst instructions.
2217 * @see llvm::CallInst::isTailCall()
2219 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2222 * Set whether a call instruction is a tail call.
2224 * This only works on llvm::CallInst instructions.
2226 * @see llvm::CallInst::setTailCall()
2228 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2235 * Obtain the default destination basic block of a switch instruction.
2237 * This only works on llvm::SwitchInst instructions.
2239 * @see llvm::SwitchInst::getDefaultDest()
2241 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2244 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2246 * Functions in this group only apply to instructions that map to
2247 * llvm::PHINode instances.
2253 * Add an incoming value to the end of a PHI list.
2255 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2256 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2259 * Obtain the number of incoming basic blocks to a PHI node.
2261 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2264 * Obtain an incoming value to a PHI node as a LLVMValueRef.
2266 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2269 * Obtain an incoming value to a PHI node as a LLVMBasicBlockRef.
2271 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2286 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2288 * An instruction builder represents a point within a basic block and is
2289 * the exclusive means of building instructions using the C interface.
2294 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2295 LLVMBuilderRef LLVMCreateBuilder(void);
2296 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2297 LLVMValueRef Instr);
2298 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2299 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2300 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2301 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2302 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2303 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2305 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2308 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2309 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2310 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2313 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2314 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2315 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2317 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2318 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2319 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2320 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2321 LLVMBasicBlockRef Else, unsigned NumCases);
2322 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2324 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2325 LLVMValueRef *Args, unsigned NumArgs,
2326 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2328 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2329 LLVMValueRef PersFn, unsigned NumClauses,
2331 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2332 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2334 /* Add a case to the switch instruction */
2335 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2336 LLVMBasicBlockRef Dest);
2338 /* Add a destination to the indirectbr instruction */
2339 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2341 /* Add a catch or filter clause to the landingpad instruction */
2342 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2344 /* Set the 'cleanup' flag in the landingpad instruction */
2345 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2348 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2350 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2352 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2354 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2356 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2358 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2360 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2362 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2364 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2366 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2368 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2370 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2372 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2374 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2376 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2378 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2380 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2382 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2384 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2386 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2388 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2390 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2392 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2394 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2396 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2398 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2399 LLVMValueRef LHS, LLVMValueRef RHS,
2401 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2402 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2404 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2406 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2407 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2410 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2411 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2412 LLVMValueRef Val, const char *Name);
2413 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2414 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2415 LLVMValueRef Val, const char *Name);
2416 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2417 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2419 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2420 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2421 LLVMValueRef *Indices, unsigned NumIndices,
2423 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2424 LLVMValueRef *Indices, unsigned NumIndices,
2426 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2427 unsigned Idx, const char *Name);
2428 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2430 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2432 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2433 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2436 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2437 LLVMTypeRef DestTy, const char *Name);
2438 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2439 LLVMTypeRef DestTy, const char *Name);
2440 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2441 LLVMTypeRef DestTy, const char *Name);
2442 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2443 LLVMTypeRef DestTy, const char *Name);
2444 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2445 LLVMTypeRef DestTy, const char *Name);
2446 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2447 LLVMTypeRef DestTy, const char *Name);
2448 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2449 LLVMTypeRef DestTy, const char *Name);
2450 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2451 LLVMTypeRef DestTy, const char *Name);
2452 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2453 LLVMTypeRef DestTy, const char *Name);
2454 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2455 LLVMTypeRef DestTy, const char *Name);
2456 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2457 LLVMTypeRef DestTy, const char *Name);
2458 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2459 LLVMTypeRef DestTy, const char *Name);
2460 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2461 LLVMTypeRef DestTy, const char *Name);
2462 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2463 LLVMTypeRef DestTy, const char *Name);
2464 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2465 LLVMTypeRef DestTy, const char *Name);
2466 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2467 LLVMTypeRef DestTy, const char *Name);
2468 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2469 LLVMTypeRef DestTy, const char *Name);
2470 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2471 LLVMTypeRef DestTy, const char *Name);
2472 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2473 LLVMTypeRef DestTy, const char *Name);
2476 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2477 LLVMValueRef LHS, LLVMValueRef RHS,
2479 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2480 LLVMValueRef LHS, LLVMValueRef RHS,
2483 /* Miscellaneous instructions */
2484 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2485 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2486 LLVMValueRef *Args, unsigned NumArgs,
2488 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2489 LLVMValueRef Then, LLVMValueRef Else,
2491 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2493 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2494 LLVMValueRef Index, const char *Name);
2495 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2496 LLVMValueRef EltVal, LLVMValueRef Index,
2498 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2499 LLVMValueRef V2, LLVMValueRef Mask,
2501 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2502 unsigned Index, const char *Name);
2503 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2504 LLVMValueRef EltVal, unsigned Index,
2507 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2509 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2511 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2512 LLVMValueRef RHS, const char *Name);
2519 * @defgroup LLVMCCoreModuleProvider Module Providers
2525 * Changes the type of M so it can be passed to FunctionPassManagers and the
2526 * JIT. They take ModuleProviders for historical reasons.
2528 LLVMModuleProviderRef
2529 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2532 * Destroys the module M.
2534 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2541 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2546 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2547 LLVMMemoryBufferRef *OutMemBuf,
2549 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2551 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2558 * @defgroup LLVMCCorePassRegistry Pass Registry
2563 /** Return the global pass registry, for use with initialization functions.
2564 @see llvm::PassRegistry::getPassRegistry */
2565 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2572 * @defgroup LLVMCCorePassManagers Pass Managers
2577 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2578 suitable for link-time optimization and whole-module transformations.
2579 @see llvm::PassManager::PassManager */
2580 LLVMPassManagerRef LLVMCreatePassManager(void);
2582 /** Constructs a new function-by-function pass pipeline over the module
2583 provider. It does not take ownership of the module provider. This type of
2584 pipeline is suitable for code generation and JIT compilation tasks.
2585 @see llvm::FunctionPassManager::FunctionPassManager */
2586 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2588 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2589 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2591 /** Initializes, executes on the provided module, and finalizes all of the
2592 passes scheduled in the pass manager. Returns 1 if any of the passes
2593 modified the module, 0 otherwise.
2594 @see llvm::PassManager::run(Module&) */
2595 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2597 /** Initializes all of the function passes scheduled in the function pass
2598 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2599 @see llvm::FunctionPassManager::doInitialization */
2600 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2602 /** Executes all of the function passes scheduled in the function pass manager
2603 on the provided function. Returns 1 if any of the passes modified the
2604 function, false otherwise.
2605 @see llvm::FunctionPassManager::run(Function&) */
2606 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2608 /** Finalizes all of the function passes scheduled in in the function pass
2609 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2610 @see llvm::FunctionPassManager::doFinalization */
2611 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2613 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2614 the module provider.
2615 @see llvm::PassManagerBase::~PassManagerBase. */
2616 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2635 class PassManagerBase;
2637 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
2638 inline ty *unwrap(ref P) { \
2639 return reinterpret_cast<ty*>(P); \
2642 inline ref wrap(const ty *P) { \
2643 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
2646 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
2647 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
2649 template<typename T> \
2650 inline T *unwrap(ref P) { \
2651 return cast<T>(unwrap(P)); \
2654 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
2655 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
2657 template<typename T> \
2658 inline T *unwrap(ref P) { \
2659 T *Q = (T*)unwrap(P); \
2660 assert(Q && "Invalid cast!"); \
2664 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
2665 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
2666 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
2667 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
2668 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
2669 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
2670 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
2671 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
2672 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
2673 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
2674 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
2677 inline Module *unwrap(LLVMModuleProviderRef MP) {
2678 return reinterpret_cast<Module*>(MP);
2681 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
2682 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
2683 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
2685 /* Specialized opaque context conversions.
2687 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
2688 return reinterpret_cast<LLVMContext**>(Tys);
2691 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
2692 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
2695 /* Specialized opaque type conversions.
2697 inline Type **unwrap(LLVMTypeRef* Tys) {
2698 return reinterpret_cast<Type**>(Tys);
2701 inline LLVMTypeRef *wrap(Type **Tys) {
2702 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
2705 /* Specialized opaque value conversions.
2707 inline Value **unwrap(LLVMValueRef *Vals) {
2708 return reinterpret_cast<Value**>(Vals);
2711 template<typename T>
2712 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
2714 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
2718 return reinterpret_cast<T**>(Vals);
2721 inline LLVMValueRef *wrap(const Value **Vals) {
2722 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
2726 #endif /* !defined(__cplusplus) */
2728 #endif /* !defined(LLVM_C_CORE_H) */