1 /*===-- llvm-c/Core.h - Core Library C Interface ------------------*- C -*-===*\
3 |* The LLVM Compiler Infrastructure *|
5 |* This file is distributed under the University of Illinois Open Source *|
6 |* License. See LICENSE.TXT for details. *|
8 |*===----------------------------------------------------------------------===*|
10 |* This header declares the C interface to libLLVMCore.a, which implements *|
11 |* the LLVM intermediate representation. *|
13 \*===----------------------------------------------------------------------===*/
18 #include "llvm/Support/DataTypes.h"
25 * @defgroup LLVMC LLVM-C: C interface to LLVM
27 * This module exposes parts of the LLVM library as a C API.
33 * @defgroup LLVMCTransforms Transforms
37 * @defgroup LLVMCCore Core
39 * This modules provide an interface to libLLVMCore, which implements
40 * the LLVM intermediate representation as well as other related types
43 * LLVM uses a polymorphic type hierarchy which C cannot represent, therefore
44 * parameters must be passed as base types. Despite the declared types, most
45 * of the functions provided operate only on branches of the type hierarchy.
46 * The declared parameter names are descriptive and specify which type is
47 * required. Additionally, each type hierarchy is documented along with the
48 * functions that operate upon it. For more detail, refer to LLVM's C++ code.
49 * If in doubt, refer to Core.cpp, which performs parameter downcasts in the
50 * form unwrap<RequiredType>(Param).
52 * Many exotic languages can interoperate with C code but have a harder time
53 * with C++ due to name mangling. So in addition to C, this interface enables
54 * tools written in such languages.
60 * @defgroup LLVMCCoreTypes Types and Enumerations
70 * The top-level container for all LLVM global data. See the LLVMContext class.
72 typedef struct LLVMOpaqueContext *LLVMContextRef;
75 * The top-level container for all other LLVM Intermediate Representation (IR)
80 typedef struct LLVMOpaqueModule *LLVMModuleRef;
83 * Each value in the LLVM IR has a type, an LLVMTypeRef.
87 typedef struct LLVMOpaqueType *LLVMTypeRef;
90 * Represents an individual value in LLVM IR.
92 * This models llvm::Value.
94 typedef struct LLVMOpaqueValue *LLVMValueRef;
97 * Represents a basic block of instructions in LLVM IR.
99 * This models llvm::BasicBlock.
101 typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
104 * Represents an LLVM basic block builder.
106 * This models llvm::IRBuilder.
108 typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
111 * Interface used to provide a module to JIT or interpreter.
112 * This is now just a synonym for llvm::Module, but we have to keep using the
113 * different type to keep binary compatibility.
115 typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
118 * Used to provide a module to JIT or interpreter.
120 * @see llvm::MemoryBuffer
122 typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
124 /** @see llvm::PassManagerBase */
125 typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
127 /** @see llvm::PassRegistry */
128 typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef;
131 * Used to get the users and usees of a Value.
134 typedef struct LLVMOpaqueUse *LLVMUseRef;
137 LLVMZExtAttribute = 1<<0,
138 LLVMSExtAttribute = 1<<1,
139 LLVMNoReturnAttribute = 1<<2,
140 LLVMInRegAttribute = 1<<3,
141 LLVMStructRetAttribute = 1<<4,
142 LLVMNoUnwindAttribute = 1<<5,
143 LLVMNoAliasAttribute = 1<<6,
144 LLVMByValAttribute = 1<<7,
145 LLVMNestAttribute = 1<<8,
146 LLVMReadNoneAttribute = 1<<9,
147 LLVMReadOnlyAttribute = 1<<10,
148 LLVMNoInlineAttribute = 1<<11,
149 LLVMAlwaysInlineAttribute = 1<<12,
150 LLVMOptimizeForSizeAttribute = 1<<13,
151 LLVMStackProtectAttribute = 1<<14,
152 LLVMStackProtectReqAttribute = 1<<15,
153 LLVMAlignment = 31<<16,
154 LLVMNoCaptureAttribute = 1<<21,
155 LLVMNoRedZoneAttribute = 1<<22,
156 LLVMNoImplicitFloatAttribute = 1<<23,
157 LLVMNakedAttribute = 1<<24,
158 LLVMInlineHintAttribute = 1<<25,
159 LLVMStackAlignment = 7<<26,
160 LLVMReturnsTwice = 1 << 29,
161 LLVMUWTable = 1 << 30,
162 LLVMNonLazyBind = 1 << 31
164 /* FIXME: These attributes are currently not included in the C API as
165 a temporary measure until the API/ABI impact to the C API is understood
166 and the path forward agreed upon.
167 LLVMAddressSafety = 1ULL << 32,
168 LLVMStackProtectStrongAttribute = 1ULL<<33,
169 LLVMCold = 1ULL << 34,
170 LLVMOptimizeNone = 1ULL << 35
175 /* Terminator Instructions */
181 /* removed 6 due to API changes */
184 /* Standard Binary Operators */
198 /* Logical Operators */
206 /* Memory Operators */
210 LLVMGetElementPtr = 29,
226 /* Other Operators */
235 LLVMExtractElement = 50,
236 LLVMInsertElement = 51,
237 LLVMShuffleVector = 52,
238 LLVMExtractValue = 53,
239 LLVMInsertValue = 54,
241 /* Atomic operators */
243 LLVMAtomicCmpXchg = 56,
246 /* Exception Handling Operators */
253 LLVMVoidTypeKind, /**< type with no size */
254 LLVMHalfTypeKind, /**< 16 bit floating point type */
255 LLVMFloatTypeKind, /**< 32 bit floating point type */
256 LLVMDoubleTypeKind, /**< 64 bit floating point type */
257 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
258 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
259 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
260 LLVMLabelTypeKind, /**< Labels */
261 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
262 LLVMFunctionTypeKind, /**< Functions */
263 LLVMStructTypeKind, /**< Structures */
264 LLVMArrayTypeKind, /**< Arrays */
265 LLVMPointerTypeKind, /**< Pointers */
266 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
267 LLVMMetadataTypeKind, /**< Metadata */
268 LLVMX86_MMXTypeKind /**< X86 MMX */
272 LLVMExternalLinkage, /**< Externally visible function */
273 LLVMAvailableExternallyLinkage,
274 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
275 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
277 LLVMLinkOnceODRAutoHideLinkage, /**< Like LinkOnceODR, but possibly hidden. */
278 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
279 LLVMWeakODRLinkage, /**< Same, but only replaced by something
281 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
282 LLVMInternalLinkage, /**< Rename collisions when linking (static
284 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
285 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
286 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
287 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
288 LLVMGhostLinkage, /**< Obsolete */
289 LLVMCommonLinkage, /**< Tentative definitions */
290 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
291 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
295 LLVMDefaultVisibility, /**< The GV is visible */
296 LLVMHiddenVisibility, /**< The GV is hidden */
297 LLVMProtectedVisibility /**< The GV is protected */
302 LLVMFastCallConv = 8,
303 LLVMColdCallConv = 9,
304 LLVMX86StdcallCallConv = 64,
305 LLVMX86FastcallCallConv = 65
309 LLVMIntEQ = 32, /**< equal */
310 LLVMIntNE, /**< not equal */
311 LLVMIntUGT, /**< unsigned greater than */
312 LLVMIntUGE, /**< unsigned greater or equal */
313 LLVMIntULT, /**< unsigned less than */
314 LLVMIntULE, /**< unsigned less or equal */
315 LLVMIntSGT, /**< signed greater than */
316 LLVMIntSGE, /**< signed greater or equal */
317 LLVMIntSLT, /**< signed less than */
318 LLVMIntSLE /**< signed less or equal */
322 LLVMRealPredicateFalse, /**< Always false (always folded) */
323 LLVMRealOEQ, /**< True if ordered and equal */
324 LLVMRealOGT, /**< True if ordered and greater than */
325 LLVMRealOGE, /**< True if ordered and greater than or equal */
326 LLVMRealOLT, /**< True if ordered and less than */
327 LLVMRealOLE, /**< True if ordered and less than or equal */
328 LLVMRealONE, /**< True if ordered and operands are unequal */
329 LLVMRealORD, /**< True if ordered (no nans) */
330 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
331 LLVMRealUEQ, /**< True if unordered or equal */
332 LLVMRealUGT, /**< True if unordered or greater than */
333 LLVMRealUGE, /**< True if unordered, greater than, or equal */
334 LLVMRealULT, /**< True if unordered or less than */
335 LLVMRealULE, /**< True if unordered, less than, or equal */
336 LLVMRealUNE, /**< True if unordered or not equal */
337 LLVMRealPredicateTrue /**< Always true (always folded) */
341 LLVMLandingPadCatch, /**< A catch clause */
342 LLVMLandingPadFilter /**< A filter clause */
343 } LLVMLandingPadClauseTy;
346 LLVMNotThreadLocal = 0,
347 LLVMGeneralDynamicTLSModel,
348 LLVMLocalDynamicTLSModel,
349 LLVMInitialExecTLSModel,
350 LLVMLocalExecTLSModel
351 } LLVMThreadLocalMode;
354 LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */
355 LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees
356 somewhat sane results, lock free. */
357 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the
358 operations affecting a specific address,
359 a consistent ordering exists */
360 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort
361 necessary to acquire a lock to access other
362 memory with normal loads and stores. */
363 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with
364 a barrier of the sort necessary to release
366 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
367 Release barrier (for fences and
368 operations which both read and write
370 LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics
371 for loads and Release
372 semantics for stores.
373 Additionally, it guarantees
374 that a total ordering exists
376 SequentiallyConsistent
378 } LLVMAtomicOrdering;
381 LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */
382 LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */
383 LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */
384 LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */
385 LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */
386 LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */
387 LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */
388 LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the
389 original using a signed comparison and return
391 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
392 original using a signed comparison and return
394 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
395 original using an unsigned comparison and return
397 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
398 original using an unsigned comparison and return
400 } LLVMAtomicRMWBinOp;
406 void LLVMInitializeCore(LLVMPassRegistryRef R);
408 /** Deallocate and destroy all ManagedStatic variables.
409 @see llvm::llvm_shutdown
410 @see ManagedStatic */
414 /*===-- Error handling ----------------------------------------------------===*/
416 char *LLVMCreateMessage(const char *Message);
417 void LLVMDisposeMessage(char *Message);
421 * @defgroup LLVMCCoreContext Contexts
423 * Contexts are execution states for the core LLVM IR system.
425 * Most types are tied to a context instance. Multiple contexts can
426 * exist simultaneously. A single context is not thread safe. However,
427 * different contexts can execute on different threads simultaneously.
433 * Create a new context.
435 * Every call to this function should be paired with a call to
436 * LLVMContextDispose() or the context will leak memory.
438 LLVMContextRef LLVMContextCreate(void);
441 * Obtain the global context instance.
443 LLVMContextRef LLVMGetGlobalContext(void);
446 * Destroy a context instance.
448 * This should be called for every call to LLVMContextCreate() or memory
451 void LLVMContextDispose(LLVMContextRef C);
453 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
455 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
462 * @defgroup LLVMCCoreModule Modules
464 * Modules represent the top-level structure in an LLVM program. An LLVM
465 * module is effectively a translation unit or a collection of
466 * translation units merged together.
472 * Create a new, empty module in the global context.
474 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
475 * LLVMGetGlobalContext() as the context parameter.
477 * Every invocation should be paired with LLVMDisposeModule() or memory
480 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
483 * Create a new, empty module in a specific context.
485 * Every invocation should be paired with LLVMDisposeModule() or memory
488 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
492 * Destroy a module instance.
494 * This must be called for every created module or memory will be
497 void LLVMDisposeModule(LLVMModuleRef M);
500 * Obtain the data layout for a module.
502 * @see Module::getDataLayout()
504 const char *LLVMGetDataLayout(LLVMModuleRef M);
507 * Set the data layout for a module.
509 * @see Module::setDataLayout()
511 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
514 * Obtain the target triple for a module.
516 * @see Module::getTargetTriple()
518 const char *LLVMGetTarget(LLVMModuleRef M);
521 * Set the target triple for a module.
523 * @see Module::setTargetTriple()
525 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
528 * Dump a representation of a module to stderr.
530 * @see Module::dump()
532 void LLVMDumpModule(LLVMModuleRef M);
535 * Print a representation of a module to a file. The ErrorMessage needs to be
536 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
538 * @see Module::print()
540 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
541 char **ErrorMessage);
544 * Return a string representation of the module. Use
545 * LLVMDisposeMessage to free the string.
547 * @see Module::print()
549 char *LLVMPrintModuleToString(LLVMModuleRef M);
552 * Set inline assembly for a module.
554 * @see Module::setModuleInlineAsm()
556 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
559 * Obtain the context to which this module is associated.
561 * @see Module::getContext()
563 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
566 * Obtain a Type from a module by its registered name.
568 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
571 * Obtain the number of operands for named metadata in a module.
573 * @see llvm::Module::getNamedMetadata()
575 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
578 * Obtain the named metadata operands for a module.
580 * The passed LLVMValueRef pointer should refer to an array of
581 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
582 * array will be populated with the LLVMValueRef instances. Each
583 * instance corresponds to a llvm::MDNode.
585 * @see llvm::Module::getNamedMetadata()
586 * @see llvm::MDNode::getOperand()
588 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
591 * Add an operand to named metadata.
593 * @see llvm::Module::getNamedMetadata()
594 * @see llvm::MDNode::addOperand()
596 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
600 * Add a function to a module under a specified name.
602 * @see llvm::Function::Create()
604 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
605 LLVMTypeRef FunctionTy);
608 * Obtain a Function value from a Module by its name.
610 * The returned value corresponds to a llvm::Function value.
612 * @see llvm::Module::getFunction()
614 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
617 * Obtain an iterator to the first Function in a Module.
619 * @see llvm::Module::begin()
621 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
624 * Obtain an iterator to the last Function in a Module.
626 * @see llvm::Module::end()
628 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
631 * Advance a Function iterator to the next Function.
633 * Returns NULL if the iterator was already at the end and there are no more
636 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
639 * Decrement a Function iterator to the previous Function.
641 * Returns NULL if the iterator was already at the beginning and there are
642 * no previous functions.
644 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
651 * @defgroup LLVMCCoreType Types
653 * Types represent the type of a value.
655 * Types are associated with a context instance. The context internally
656 * deduplicates types so there is only 1 instance of a specific type
657 * alive at a time. In other words, a unique type is shared among all
658 * consumers within a context.
660 * A Type in the C API corresponds to llvm::Type.
662 * Types have the following hierarchy:
680 * Obtain the enumerated type of a Type instance.
682 * @see llvm::Type:getTypeID()
684 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
687 * Whether the type has a known size.
689 * Things that don't have a size are abstract types, labels, and void.a
691 * @see llvm::Type::isSized()
693 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
696 * Obtain the context to which this type instance is associated.
698 * @see llvm::Type::getContext()
700 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
703 * @defgroup LLVMCCoreTypeInt Integer Types
705 * Functions in this section operate on integer types.
711 * Obtain an integer type from a context with specified bit width.
713 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
714 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
715 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
716 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
717 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
718 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
721 * Obtain an integer type from the global context with a specified bit
724 LLVMTypeRef LLVMInt1Type(void);
725 LLVMTypeRef LLVMInt8Type(void);
726 LLVMTypeRef LLVMInt16Type(void);
727 LLVMTypeRef LLVMInt32Type(void);
728 LLVMTypeRef LLVMInt64Type(void);
729 LLVMTypeRef LLVMIntType(unsigned NumBits);
730 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
737 * @defgroup LLVMCCoreTypeFloat Floating Point Types
743 * Obtain a 16-bit floating point type from a context.
745 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
748 * Obtain a 32-bit floating point type from a context.
750 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
753 * Obtain a 64-bit floating point type from a context.
755 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
758 * Obtain a 80-bit floating point type (X87) from a context.
760 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
763 * Obtain a 128-bit floating point type (112-bit mantissa) from a
766 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
769 * Obtain a 128-bit floating point type (two 64-bits) from a context.
771 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
774 * Obtain a floating point type from the global context.
776 * These map to the functions in this group of the same name.
778 LLVMTypeRef LLVMHalfType(void);
779 LLVMTypeRef LLVMFloatType(void);
780 LLVMTypeRef LLVMDoubleType(void);
781 LLVMTypeRef LLVMX86FP80Type(void);
782 LLVMTypeRef LLVMFP128Type(void);
783 LLVMTypeRef LLVMPPCFP128Type(void);
790 * @defgroup LLVMCCoreTypeFunction Function Types
796 * Obtain a function type consisting of a specified signature.
798 * The function is defined as a tuple of a return Type, a list of
799 * parameter types, and whether the function is variadic.
801 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
802 LLVMTypeRef *ParamTypes, unsigned ParamCount,
806 * Returns whether a function type is variadic.
808 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
811 * Obtain the Type this function Type returns.
813 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
816 * Obtain the number of parameters this function accepts.
818 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
821 * Obtain the types of a function's parameters.
823 * The Dest parameter should point to a pre-allocated array of
824 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
825 * first LLVMCountParamTypes() entries in the array will be populated
826 * with LLVMTypeRef instances.
828 * @param FunctionTy The function type to operate on.
829 * @param Dest Memory address of an array to be filled with result.
831 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
838 * @defgroup LLVMCCoreTypeStruct Structure Types
840 * These functions relate to LLVMTypeRef instances.
842 * @see llvm::StructType
848 * Create a new structure type in a context.
850 * A structure is specified by a list of inner elements/types and
851 * whether these can be packed together.
853 * @see llvm::StructType::create()
855 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
856 unsigned ElementCount, LLVMBool Packed);
859 * Create a new structure type in the global context.
861 * @see llvm::StructType::create()
863 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
867 * Create an empty structure in a context having a specified name.
869 * @see llvm::StructType::create()
871 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
874 * Obtain the name of a structure.
876 * @see llvm::StructType::getName()
878 const char *LLVMGetStructName(LLVMTypeRef Ty);
881 * Set the contents of a structure type.
883 * @see llvm::StructType::setBody()
885 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
886 unsigned ElementCount, LLVMBool Packed);
889 * Get the number of elements defined inside the structure.
891 * @see llvm::StructType::getNumElements()
893 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
896 * Get the elements within a structure.
898 * The function is passed the address of a pre-allocated array of
899 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
900 * invocation, this array will be populated with the structure's
901 * elements. The objects in the destination array will have a lifetime
902 * of the structure type itself, which is the lifetime of the context it
905 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
908 * Determine whether a structure is packed.
910 * @see llvm::StructType::isPacked()
912 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
915 * Determine whether a structure is opaque.
917 * @see llvm::StructType::isOpaque()
919 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
927 * @defgroup LLVMCCoreTypeSequential Sequential Types
929 * Sequential types represents "arrays" of types. This is a super class
930 * for array, vector, and pointer types.
936 * Obtain the type of elements within a sequential type.
938 * This works on array, vector, and pointer types.
940 * @see llvm::SequentialType::getElementType()
942 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
945 * Create a fixed size array type that refers to a specific type.
947 * The created type will exist in the context that its element type
950 * @see llvm::ArrayType::get()
952 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
955 * Obtain the length of an array type.
957 * This only works on types that represent arrays.
959 * @see llvm::ArrayType::getNumElements()
961 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
964 * Create a pointer type that points to a defined type.
966 * The created type will exist in the context that its pointee type
969 * @see llvm::PointerType::get()
971 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
974 * Obtain the address space of a pointer type.
976 * This only works on types that represent pointers.
978 * @see llvm::PointerType::getAddressSpace()
980 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
983 * Create a vector type that contains a defined type and has a specific
984 * number of elements.
986 * The created type will exist in the context thats its element type
989 * @see llvm::VectorType::get()
991 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
994 * Obtain the number of elements in a vector type.
996 * This only works on types that represent vectors.
998 * @see llvm::VectorType::getNumElements()
1000 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1007 * @defgroup LLVMCCoreTypeOther Other Types
1013 * Create a void type in a context.
1015 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1018 * Create a label type in a context.
1020 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1023 * Create a X86 MMX type in a context.
1025 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1028 * These are similar to the above functions except they operate on the
1031 LLVMTypeRef LLVMVoidType(void);
1032 LLVMTypeRef LLVMLabelType(void);
1033 LLVMTypeRef LLVMX86MMXType(void);
1044 * @defgroup LLVMCCoreValues Values
1046 * The bulk of LLVM's object model consists of values, which comprise a very
1047 * rich type hierarchy.
1049 * LLVMValueRef essentially represents llvm::Value. There is a rich
1050 * hierarchy of classes within this type. Depending on the instance
1051 * obtained, not all APIs are available.
1053 * Callers can determine the type of an LLVMValueRef by calling the
1054 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1055 * functions are defined by a macro, so it isn't obvious which are
1056 * available by looking at the Doxygen source code. Instead, look at the
1057 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1058 * of value names given. These value names also correspond to classes in
1059 * the llvm::Value hierarchy.
1064 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1072 macro(BlockAddress) \
1073 macro(ConstantAggregateZero) \
1074 macro(ConstantArray) \
1075 macro(ConstantExpr) \
1077 macro(ConstantInt) \
1078 macro(ConstantPointerNull) \
1079 macro(ConstantStruct) \
1080 macro(ConstantVector) \
1081 macro(GlobalValue) \
1083 macro(GlobalAlias) \
1084 macro(GlobalVariable) \
1086 macro(Instruction) \
1087 macro(BinaryOperator) \
1089 macro(IntrinsicInst) \
1090 macro(DbgInfoIntrinsic) \
1091 macro(DbgDeclareInst) \
1092 macro(MemIntrinsic) \
1094 macro(MemMoveInst) \
1099 macro(ExtractElementInst) \
1100 macro(GetElementPtrInst) \
1101 macro(InsertElementInst) \
1102 macro(InsertValueInst) \
1103 macro(LandingPadInst) \
1106 macro(ShuffleVectorInst) \
1108 macro(TerminatorInst) \
1110 macro(IndirectBrInst) \
1114 macro(UnreachableInst) \
1116 macro(UnaryInstruction) \
1119 macro(BitCastInst) \
1123 macro(FPTruncInst) \
1124 macro(IntToPtrInst) \
1125 macro(PtrToIntInst) \
1131 macro(ExtractValueInst) \
1136 * @defgroup LLVMCCoreValueGeneral General APIs
1138 * Functions in this section work on all LLVMValueRef instances,
1139 * regardless of their sub-type. They correspond to functions available
1146 * Obtain the type of a value.
1148 * @see llvm::Value::getType()
1150 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1153 * Obtain the string name of a value.
1155 * @see llvm::Value::getName()
1157 const char *LLVMGetValueName(LLVMValueRef Val);
1160 * Set the string name of a value.
1162 * @see llvm::Value::setName()
1164 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1167 * Dump a representation of a value to stderr.
1169 * @see llvm::Value::dump()
1171 void LLVMDumpValue(LLVMValueRef Val);
1174 * Replace all uses of a value with another one.
1176 * @see llvm::Value::replaceAllUsesWith()
1178 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1181 * Determine whether the specified constant instance is constant.
1183 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1186 * Determine whether a value instance is undefined.
1188 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1191 * Convert value instances between types.
1193 * Internally, an LLVMValueRef is "pinned" to a specific type. This
1194 * series of functions allows you to cast an instance to a specific
1197 * If the cast is not valid for the specified type, NULL is returned.
1199 * @see llvm::dyn_cast_or_null<>
1201 #define LLVM_DECLARE_VALUE_CAST(name) \
1202 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1203 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1210 * @defgroup LLVMCCoreValueUses Usage
1212 * This module defines functions that allow you to inspect the uses of a
1215 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1216 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1217 * llvm::User and llvm::Value.
1223 * Obtain the first use of a value.
1225 * Uses are obtained in an iterator fashion. First, call this function
1226 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1227 * on that instance and all subsequently obtained instances until
1228 * LLVMGetNextUse() returns NULL.
1230 * @see llvm::Value::use_begin()
1232 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1235 * Obtain the next use of a value.
1237 * This effectively advances the iterator. It returns NULL if you are on
1238 * the final use and no more are available.
1240 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1243 * Obtain the user value for a user.
1245 * The returned value corresponds to a llvm::User type.
1247 * @see llvm::Use::getUser()
1249 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1252 * Obtain the value this use corresponds to.
1254 * @see llvm::Use::get().
1256 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1263 * @defgroup LLVMCCoreValueUser User value
1265 * Function in this group pertain to LLVMValueRef instances that descent
1266 * from llvm::User. This includes constants, instructions, and
1273 * Obtain an operand at a specific index in a llvm::User value.
1275 * @see llvm::User::getOperand()
1277 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1280 * Set an operand at a specific index in a llvm::User value.
1282 * @see llvm::User::setOperand()
1284 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1287 * Obtain the number of operands in a llvm::User value.
1289 * @see llvm::User::getNumOperands()
1291 int LLVMGetNumOperands(LLVMValueRef Val);
1298 * @defgroup LLVMCCoreValueConstant Constants
1300 * This section contains APIs for interacting with LLVMValueRef that
1301 * correspond to llvm::Constant instances.
1303 * These functions will work for any LLVMValueRef in the llvm::Constant
1310 * Obtain a constant value referring to the null instance of a type.
1312 * @see llvm::Constant::getNullValue()
1314 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1317 * Obtain a constant value referring to the instance of a type
1318 * consisting of all ones.
1320 * This is only valid for integer types.
1322 * @see llvm::Constant::getAllOnesValue()
1324 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1327 * Obtain a constant value referring to an undefined value of a type.
1329 * @see llvm::UndefValue::get()
1331 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1334 * Determine whether a value instance is null.
1336 * @see llvm::Constant::isNullValue()
1338 LLVMBool LLVMIsNull(LLVMValueRef Val);
1341 * Obtain a constant that is a constant pointer pointing to NULL for a
1344 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1347 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1349 * Functions in this group model LLVMValueRef instances that correspond
1350 * to constants referring to scalar types.
1352 * For integer types, the LLVMTypeRef parameter should correspond to a
1353 * llvm::IntegerType instance and the returned LLVMValueRef will
1354 * correspond to a llvm::ConstantInt.
1356 * For floating point types, the LLVMTypeRef returned corresponds to a
1363 * Obtain a constant value for an integer type.
1365 * The returned value corresponds to a llvm::ConstantInt.
1367 * @see llvm::ConstantInt::get()
1369 * @param IntTy Integer type to obtain value of.
1370 * @param N The value the returned instance should refer to.
1371 * @param SignExtend Whether to sign extend the produced value.
1373 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1374 LLVMBool SignExtend);
1377 * Obtain a constant value for an integer of arbitrary precision.
1379 * @see llvm::ConstantInt::get()
1381 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1383 const uint64_t Words[]);
1386 * Obtain a constant value for an integer parsed from a string.
1388 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1389 * string's length is available, it is preferred to call that function
1392 * @see llvm::ConstantInt::get()
1394 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1398 * Obtain a constant value for an integer parsed from a string with
1401 * @see llvm::ConstantInt::get()
1403 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1404 unsigned SLen, uint8_t Radix);
1407 * Obtain a constant value referring to a double floating point value.
1409 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1412 * Obtain a constant for a floating point value parsed from a string.
1414 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1415 * should be used if the input string's length is known.
1417 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1420 * Obtain a constant for a floating point value parsed from a string.
1422 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1426 * Obtain the zero extended value for an integer constant value.
1428 * @see llvm::ConstantInt::getZExtValue()
1430 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1433 * Obtain the sign extended value for an integer constant value.
1435 * @see llvm::ConstantInt::getSExtValue()
1437 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1444 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1446 * Functions in this group operate on composite constants.
1452 * Create a ConstantDataSequential and initialize it with a string.
1454 * @see llvm::ConstantDataArray::getString()
1456 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1457 unsigned Length, LLVMBool DontNullTerminate);
1460 * Create a ConstantDataSequential with string content in the global context.
1462 * This is the same as LLVMConstStringInContext except it operates on the
1465 * @see LLVMConstStringInContext()
1466 * @see llvm::ConstantDataArray::getString()
1468 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1469 LLVMBool DontNullTerminate);
1472 * Create an anonymous ConstantStruct with the specified values.
1474 * @see llvm::ConstantStruct::getAnon()
1476 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1477 LLVMValueRef *ConstantVals,
1478 unsigned Count, LLVMBool Packed);
1481 * Create a ConstantStruct in the global Context.
1483 * This is the same as LLVMConstStructInContext except it operates on the
1486 * @see LLVMConstStructInContext()
1488 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1492 * Create a ConstantArray from values.
1494 * @see llvm::ConstantArray::get()
1496 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1497 LLVMValueRef *ConstantVals, unsigned Length);
1500 * Create a non-anonymous ConstantStruct from values.
1502 * @see llvm::ConstantStruct::get()
1504 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1505 LLVMValueRef *ConstantVals,
1509 * Create a ConstantVector from values.
1511 * @see llvm::ConstantVector::get()
1513 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1520 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1522 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1524 * @see llvm::ConstantExpr.
1528 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1529 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1530 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1531 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1532 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1533 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1534 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1535 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1536 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1537 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1538 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1539 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1540 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1541 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1542 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1543 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1544 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1545 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1546 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1547 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1548 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1549 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1550 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1551 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1552 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1553 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1554 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1555 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1556 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1557 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1558 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1559 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1560 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1561 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1562 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1563 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1564 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1565 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1566 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1567 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1568 LLVMValueRef *ConstantIndices,
1569 unsigned NumIndices);
1570 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1571 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1572 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1573 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1574 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1575 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1576 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1577 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1578 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1579 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1580 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1581 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1582 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1583 LLVMTypeRef ToType);
1584 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1585 LLVMTypeRef ToType);
1586 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1587 LLVMTypeRef ToType);
1588 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1589 LLVMTypeRef ToType);
1590 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1592 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1593 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1594 LLVMValueRef ConstantIfTrue,
1595 LLVMValueRef ConstantIfFalse);
1596 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1597 LLVMValueRef IndexConstant);
1598 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1599 LLVMValueRef ElementValueConstant,
1600 LLVMValueRef IndexConstant);
1601 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1602 LLVMValueRef VectorBConstant,
1603 LLVMValueRef MaskConstant);
1604 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1606 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1607 LLVMValueRef ElementValueConstant,
1608 unsigned *IdxList, unsigned NumIdx);
1609 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1610 const char *AsmString, const char *Constraints,
1611 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1612 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1619 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1621 * This group contains functions that operate on global values. Functions in
1622 * this group relate to functions in the llvm::GlobalValue class tree.
1624 * @see llvm::GlobalValue
1629 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1630 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1631 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1632 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1633 const char *LLVMGetSection(LLVMValueRef Global);
1634 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1635 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1636 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1637 unsigned LLVMGetAlignment(LLVMValueRef Global);
1638 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
1641 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1643 * This group contains functions that operate on global variable values.
1645 * @see llvm::GlobalVariable
1649 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1650 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1652 unsigned AddressSpace);
1653 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1654 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1655 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1656 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1657 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1658 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1659 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1660 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1661 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1662 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1663 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1664 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1665 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1666 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1667 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1668 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1675 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1677 * This group contains function that operate on global alias values.
1679 * @see llvm::GlobalAlias
1683 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1691 * @defgroup LLVMCCoreValueFunction Function values
1693 * Functions in this group operate on LLVMValueRef instances that
1694 * correspond to llvm::Function instances.
1696 * @see llvm::Function
1702 * Remove a function from its containing module and deletes it.
1704 * @see llvm::Function::eraseFromParent()
1706 void LLVMDeleteFunction(LLVMValueRef Fn);
1709 * Obtain the ID number from a function instance.
1711 * @see llvm::Function::getIntrinsicID()
1713 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1716 * Obtain the calling function of a function.
1718 * The returned value corresponds to the LLVMCallConv enumeration.
1720 * @see llvm::Function::getCallingConv()
1722 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1725 * Set the calling convention of a function.
1727 * @see llvm::Function::setCallingConv()
1729 * @param Fn Function to operate on
1730 * @param CC LLVMCallConv to set calling convention to
1732 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1735 * Obtain the name of the garbage collector to use during code
1738 * @see llvm::Function::getGC()
1740 const char *LLVMGetGC(LLVMValueRef Fn);
1743 * Define the garbage collector to use during code generation.
1745 * @see llvm::Function::setGC()
1747 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1750 * Add an attribute to a function.
1752 * @see llvm::Function::addAttribute()
1754 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1757 * Add a target-dependent attribute to a fuction
1758 * @see llvm::AttrBuilder::addAttribute()
1760 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1764 * Obtain an attribute from a function.
1766 * @see llvm::Function::getAttributes()
1768 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1771 * Remove an attribute from a function.
1773 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1776 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1778 * Functions in this group relate to arguments/parameters on functions.
1780 * Functions in this group expect LLVMValueRef instances that correspond
1781 * to llvm::Function instances.
1787 * Obtain the number of parameters in a function.
1789 * @see llvm::Function::arg_size()
1791 unsigned LLVMCountParams(LLVMValueRef Fn);
1794 * Obtain the parameters in a function.
1796 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1797 * at least LLVMCountParams() long. This array will be filled with
1798 * LLVMValueRef instances which correspond to the parameters the
1799 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1802 * @see llvm::Function::arg_begin()
1804 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1807 * Obtain the parameter at the specified index.
1809 * Parameters are indexed from 0.
1811 * @see llvm::Function::arg_begin()
1813 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1816 * Obtain the function to which this argument belongs.
1818 * Unlike other functions in this group, this one takes an LLVMValueRef
1819 * that corresponds to a llvm::Attribute.
1821 * The returned LLVMValueRef is the llvm::Function to which this
1824 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1827 * Obtain the first parameter to a function.
1829 * @see llvm::Function::arg_begin()
1831 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1834 * Obtain the last parameter to a function.
1836 * @see llvm::Function::arg_end()
1838 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
1841 * Obtain the next parameter to a function.
1843 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
1844 * actually a wrapped iterator) and obtains the next parameter from the
1845 * underlying iterator.
1847 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
1850 * Obtain the previous parameter to a function.
1852 * This is the opposite of LLVMGetNextParam().
1854 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
1857 * Add an attribute to a function argument.
1859 * @see llvm::Argument::addAttr()
1861 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1864 * Remove an attribute from a function argument.
1866 * @see llvm::Argument::removeAttr()
1868 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1871 * Get an attribute from a function argument.
1873 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
1876 * Set the alignment for a function parameter.
1878 * @see llvm::Argument::addAttr()
1879 * @see llvm::AttrBuilder::addAlignmentAttr()
1881 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
1900 * @defgroup LLVMCCoreValueMetadata Metadata
1906 * Obtain a MDString value from a context.
1908 * The returned instance corresponds to the llvm::MDString class.
1910 * The instance is specified by string data of a specified length. The
1911 * string content is copied, so the backing memory can be freed after
1912 * this function returns.
1914 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
1918 * Obtain a MDString value from the global context.
1920 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
1923 * Obtain a MDNode value from a context.
1925 * The returned value corresponds to the llvm::MDNode class.
1927 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
1931 * Obtain a MDNode value from the global context.
1933 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
1936 * Obtain the underlying string from a MDString value.
1938 * @param V Instance to obtain string from.
1939 * @param Len Memory address which will hold length of returned string.
1940 * @return String data in MDString.
1942 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
1945 * Obtain the number of operands from an MDNode value.
1947 * @param V MDNode to get number of operands from.
1948 * @return Number of operands of the MDNode.
1950 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
1953 * Obtain the given MDNode's operands.
1955 * The passed LLVMValueRef pointer should point to enough memory to hold all of
1956 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
1957 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
1958 * MDNode's operands.
1960 * @param V MDNode to get the operands from.
1961 * @param Dest Destination array for operands.
1963 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
1970 * @defgroup LLVMCCoreValueBasicBlock Basic Block
1972 * A basic block represents a single entry single exit section of code.
1973 * Basic blocks contain a list of instructions which form the body of
1976 * Basic blocks belong to functions. They have the type of label.
1978 * Basic blocks are themselves values. However, the C API models them as
1979 * LLVMBasicBlockRef.
1981 * @see llvm::BasicBlock
1987 * Convert a basic block instance to a value type.
1989 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
1992 * Determine whether an LLVMValueRef is itself a basic block.
1994 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
1997 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
1999 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
2002 * Obtain the function to which a basic block belongs.
2004 * @see llvm::BasicBlock::getParent()
2006 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2009 * Obtain the terminator instruction for a basic block.
2011 * If the basic block does not have a terminator (it is not well-formed
2012 * if it doesn't), then NULL is returned.
2014 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2016 * @see llvm::BasicBlock::getTerminator()
2018 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2021 * Obtain the number of basic blocks in a function.
2023 * @param Fn Function value to operate on.
2025 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2028 * Obtain all of the basic blocks in a function.
2030 * This operates on a function value. The BasicBlocks parameter is a
2031 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2032 * LLVMCountBasicBlocks() in length. This array is populated with
2033 * LLVMBasicBlockRef instances.
2035 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2038 * Obtain the first basic block in a function.
2040 * The returned basic block can be used as an iterator. You will likely
2041 * eventually call into LLVMGetNextBasicBlock() with it.
2043 * @see llvm::Function::begin()
2045 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2048 * Obtain the last basic block in a function.
2050 * @see llvm::Function::end()
2052 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2055 * Advance a basic block iterator.
2057 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2060 * Go backwards in a basic block iterator.
2062 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2065 * Obtain the basic block that corresponds to the entry point of a
2068 * @see llvm::Function::getEntryBlock()
2070 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2073 * Append a basic block to the end of a function.
2075 * @see llvm::BasicBlock::Create()
2077 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2082 * Append a basic block to the end of a function using the global
2085 * @see llvm::BasicBlock::Create()
2087 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2090 * Insert a basic block in a function before another basic block.
2092 * The function to add to is determined by the function of the
2093 * passed basic block.
2095 * @see llvm::BasicBlock::Create()
2097 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2098 LLVMBasicBlockRef BB,
2102 * Insert a basic block in a function using the global context.
2104 * @see llvm::BasicBlock::Create()
2106 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2110 * Remove a basic block from a function and delete it.
2112 * This deletes the basic block from its containing function and deletes
2113 * the basic block itself.
2115 * @see llvm::BasicBlock::eraseFromParent()
2117 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2120 * Remove a basic block from a function.
2122 * This deletes the basic block from its containing function but keep
2123 * the basic block alive.
2125 * @see llvm::BasicBlock::removeFromParent()
2127 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2130 * Move a basic block to before another one.
2132 * @see llvm::BasicBlock::moveBefore()
2134 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2137 * Move a basic block to after another one.
2139 * @see llvm::BasicBlock::moveAfter()
2141 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2144 * Obtain the first instruction in a basic block.
2146 * The returned LLVMValueRef corresponds to a llvm::Instruction
2149 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2152 * Obtain the last instruction in a basic block.
2154 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2156 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2163 * @defgroup LLVMCCoreValueInstruction Instructions
2165 * Functions in this group relate to the inspection and manipulation of
2166 * individual instructions.
2168 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2169 * class has a large number of descendents. llvm::Instruction is a
2170 * llvm::Value and in the C API, instructions are modeled by
2173 * This group also contains sub-groups which operate on specific
2174 * llvm::Instruction types, e.g. llvm::CallInst.
2180 * Determine whether an instruction has any metadata attached.
2182 int LLVMHasMetadata(LLVMValueRef Val);
2185 * Return metadata associated with an instruction value.
2187 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2190 * Set metadata associated with an instruction value.
2192 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2195 * Obtain the basic block to which an instruction belongs.
2197 * @see llvm::Instruction::getParent()
2199 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2202 * Obtain the instruction that occurs after the one specified.
2204 * The next instruction will be from the same basic block.
2206 * If this is the last instruction in a basic block, NULL will be
2209 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2212 * Obtain the instruction that occurred before this one.
2214 * If the instruction is the first instruction in a basic block, NULL
2217 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2220 * Remove and delete an instruction.
2222 * The instruction specified is removed from its containing building
2223 * block and then deleted.
2225 * @see llvm::Instruction::eraseFromParent()
2227 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2230 * Obtain the code opcode for an individual instruction.
2232 * @see llvm::Instruction::getOpCode()
2234 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2237 * Obtain the predicate of an instruction.
2239 * This is only valid for instructions that correspond to llvm::ICmpInst
2240 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2242 * @see llvm::ICmpInst::getPredicate()
2244 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2247 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2249 * Functions in this group apply to instructions that refer to call
2250 * sites and invocations. These correspond to C++ types in the
2251 * llvm::CallInst class tree.
2257 * Set the calling convention for a call instruction.
2259 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2262 * @see llvm::CallInst::setCallingConv()
2263 * @see llvm::InvokeInst::setCallingConv()
2265 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2268 * Obtain the calling convention for a call instruction.
2270 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2273 * @see LLVMSetInstructionCallConv()
2275 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2278 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2279 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2281 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2285 * Obtain whether a call instruction is a tail call.
2287 * This only works on llvm::CallInst instructions.
2289 * @see llvm::CallInst::isTailCall()
2291 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2294 * Set whether a call instruction is a tail call.
2296 * This only works on llvm::CallInst instructions.
2298 * @see llvm::CallInst::setTailCall()
2300 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2307 * Obtain the default destination basic block of a switch instruction.
2309 * This only works on llvm::SwitchInst instructions.
2311 * @see llvm::SwitchInst::getDefaultDest()
2313 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2316 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2318 * Functions in this group only apply to instructions that map to
2319 * llvm::PHINode instances.
2325 * Add an incoming value to the end of a PHI list.
2327 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2328 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2331 * Obtain the number of incoming basic blocks to a PHI node.
2333 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2336 * Obtain an incoming value to a PHI node as an LLVMValueRef.
2338 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2341 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2343 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2358 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2360 * An instruction builder represents a point within a basic block and is
2361 * the exclusive means of building instructions using the C interface.
2366 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2367 LLVMBuilderRef LLVMCreateBuilder(void);
2368 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2369 LLVMValueRef Instr);
2370 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2371 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2372 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2373 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2374 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2375 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2377 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2380 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2381 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2382 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2385 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2386 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2387 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2389 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2390 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2391 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2392 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2393 LLVMBasicBlockRef Else, unsigned NumCases);
2394 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2396 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2397 LLVMValueRef *Args, unsigned NumArgs,
2398 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2400 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2401 LLVMValueRef PersFn, unsigned NumClauses,
2403 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2404 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2406 /* Add a case to the switch instruction */
2407 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2408 LLVMBasicBlockRef Dest);
2410 /* Add a destination to the indirectbr instruction */
2411 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2413 /* Add a catch or filter clause to the landingpad instruction */
2414 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2416 /* Set the 'cleanup' flag in the landingpad instruction */
2417 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2420 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2422 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2424 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2426 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2428 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2430 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2432 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2434 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2436 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2438 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2440 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2442 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2444 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2446 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2448 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2450 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2452 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2454 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2456 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2458 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2460 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2462 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2464 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2466 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2468 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2470 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2471 LLVMValueRef LHS, LLVMValueRef RHS,
2473 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2474 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2476 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2478 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2479 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2482 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2483 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2484 LLVMValueRef Val, const char *Name);
2485 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2486 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2487 LLVMValueRef Val, const char *Name);
2488 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2489 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2491 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2492 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2493 LLVMValueRef *Indices, unsigned NumIndices,
2495 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2496 LLVMValueRef *Indices, unsigned NumIndices,
2498 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2499 unsigned Idx, const char *Name);
2500 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2502 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2504 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2505 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2508 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2509 LLVMTypeRef DestTy, const char *Name);
2510 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2511 LLVMTypeRef DestTy, const char *Name);
2512 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2513 LLVMTypeRef DestTy, const char *Name);
2514 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2515 LLVMTypeRef DestTy, const char *Name);
2516 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2517 LLVMTypeRef DestTy, const char *Name);
2518 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2519 LLVMTypeRef DestTy, const char *Name);
2520 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2521 LLVMTypeRef DestTy, const char *Name);
2522 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2523 LLVMTypeRef DestTy, const char *Name);
2524 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2525 LLVMTypeRef DestTy, const char *Name);
2526 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2527 LLVMTypeRef DestTy, const char *Name);
2528 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2529 LLVMTypeRef DestTy, const char *Name);
2530 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2531 LLVMTypeRef DestTy, const char *Name);
2532 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2533 LLVMTypeRef DestTy, const char *Name);
2534 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2535 LLVMTypeRef DestTy, const char *Name);
2536 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2537 LLVMTypeRef DestTy, const char *Name);
2538 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2539 LLVMTypeRef DestTy, const char *Name);
2540 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2541 LLVMTypeRef DestTy, const char *Name);
2542 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2543 LLVMTypeRef DestTy, const char *Name);
2544 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2545 LLVMTypeRef DestTy, const char *Name);
2548 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2549 LLVMValueRef LHS, LLVMValueRef RHS,
2551 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2552 LLVMValueRef LHS, LLVMValueRef RHS,
2555 /* Miscellaneous instructions */
2556 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2557 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2558 LLVMValueRef *Args, unsigned NumArgs,
2560 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2561 LLVMValueRef Then, LLVMValueRef Else,
2563 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2565 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2566 LLVMValueRef Index, const char *Name);
2567 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2568 LLVMValueRef EltVal, LLVMValueRef Index,
2570 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2571 LLVMValueRef V2, LLVMValueRef Mask,
2573 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2574 unsigned Index, const char *Name);
2575 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2576 LLVMValueRef EltVal, unsigned Index,
2579 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2581 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2583 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2584 LLVMValueRef RHS, const char *Name);
2585 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B,LLVMAtomicRMWBinOp op,
2586 LLVMValueRef PTR, LLVMValueRef Val,
2587 LLVMAtomicOrdering ordering,
2588 LLVMBool singleThread);
2595 * @defgroup LLVMCCoreModuleProvider Module Providers
2601 * Changes the type of M so it can be passed to FunctionPassManagers and the
2602 * JIT. They take ModuleProviders for historical reasons.
2604 LLVMModuleProviderRef
2605 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2608 * Destroys the module M.
2610 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2617 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2622 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2623 LLVMMemoryBufferRef *OutMemBuf,
2625 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2627 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2628 size_t InputDataLength,
2629 const char *BufferName,
2630 LLVMBool RequiresNullTerminator);
2631 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2632 size_t InputDataLength,
2633 const char *BufferName);
2634 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2635 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2636 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2643 * @defgroup LLVMCCorePassRegistry Pass Registry
2648 /** Return the global pass registry, for use with initialization functions.
2649 @see llvm::PassRegistry::getPassRegistry */
2650 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2657 * @defgroup LLVMCCorePassManagers Pass Managers
2662 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2663 suitable for link-time optimization and whole-module transformations.
2664 @see llvm::PassManager::PassManager */
2665 LLVMPassManagerRef LLVMCreatePassManager(void);
2667 /** Constructs a new function-by-function pass pipeline over the module
2668 provider. It does not take ownership of the module provider. This type of
2669 pipeline is suitable for code generation and JIT compilation tasks.
2670 @see llvm::FunctionPassManager::FunctionPassManager */
2671 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2673 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2674 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2676 /** Initializes, executes on the provided module, and finalizes all of the
2677 passes scheduled in the pass manager. Returns 1 if any of the passes
2678 modified the module, 0 otherwise.
2679 @see llvm::PassManager::run(Module&) */
2680 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2682 /** Initializes all of the function passes scheduled in the function pass
2683 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2684 @see llvm::FunctionPassManager::doInitialization */
2685 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2687 /** Executes all of the function passes scheduled in the function pass manager
2688 on the provided function. Returns 1 if any of the passes modified the
2689 function, false otherwise.
2690 @see llvm::FunctionPassManager::run(Function&) */
2691 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2693 /** Finalizes all of the function passes scheduled in in the function pass
2694 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2695 @see llvm::FunctionPassManager::doFinalization */
2696 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2698 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2699 the module provider.
2700 @see llvm::PassManagerBase::~PassManagerBase. */
2701 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2708 * @defgroup LLVMCCoreThreading Threading
2710 * Handle the structures needed to make LLVM safe for multithreading.
2715 /** Allocate and initialize structures needed to make LLVM safe for
2716 multithreading. The return value indicates whether multithreaded
2717 initialization succeeded. Must be executed in isolation from all
2718 other LLVM api calls.
2719 @see llvm::llvm_start_multithreaded */
2720 LLVMBool LLVMStartMultithreaded();
2722 /** Deallocate structures necessary to make LLVM safe for multithreading.
2723 Must be executed in isolation from all other LLVM api calls.
2724 @see llvm::llvm_stop_multithreaded */
2725 void LLVMStopMultithreaded();
2727 /** Check whether LLVM is executing in thread-safe mode or not.
2728 @see llvm::llvm_is_multithreaded */
2729 LLVMBool LLVMIsMultithreaded();
2745 #endif /* !defined(__cplusplus) */
2747 #endif /* !defined(LLVM_C_CORE_H) */