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 * Set inline assembly for a module.
546 * @see Module::setModuleInlineAsm()
548 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
551 * Obtain the context to which this module is associated.
553 * @see Module::getContext()
555 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
558 * Obtain a Type from a module by its registered name.
560 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
563 * Obtain the number of operands for named metadata in a module.
565 * @see llvm::Module::getNamedMetadata()
567 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
570 * Obtain the named metadata operands for a module.
572 * The passed LLVMValueRef pointer should refer to an array of
573 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
574 * array will be populated with the LLVMValueRef instances. Each
575 * instance corresponds to a llvm::MDNode.
577 * @see llvm::Module::getNamedMetadata()
578 * @see llvm::MDNode::getOperand()
580 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
583 * Add an operand to named metadata.
585 * @see llvm::Module::getNamedMetadata()
586 * @see llvm::MDNode::addOperand()
588 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
592 * Add a function to a module under a specified name.
594 * @see llvm::Function::Create()
596 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
597 LLVMTypeRef FunctionTy);
600 * Obtain a Function value from a Module by its name.
602 * The returned value corresponds to a llvm::Function value.
604 * @see llvm::Module::getFunction()
606 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
609 * Obtain an iterator to the first Function in a Module.
611 * @see llvm::Module::begin()
613 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
616 * Obtain an iterator to the last Function in a Module.
618 * @see llvm::Module::end()
620 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
623 * Advance a Function iterator to the next Function.
625 * Returns NULL if the iterator was already at the end and there are no more
628 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
631 * Decrement a Function iterator to the previous Function.
633 * Returns NULL if the iterator was already at the beginning and there are
634 * no previous functions.
636 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
643 * @defgroup LLVMCCoreType Types
645 * Types represent the type of a value.
647 * Types are associated with a context instance. The context internally
648 * deduplicates types so there is only 1 instance of a specific type
649 * alive at a time. In other words, a unique type is shared among all
650 * consumers within a context.
652 * A Type in the C API corresponds to llvm::Type.
654 * Types have the following hierarchy:
672 * Obtain the enumerated type of a Type instance.
674 * @see llvm::Type:getTypeID()
676 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
679 * Whether the type has a known size.
681 * Things that don't have a size are abstract types, labels, and void.a
683 * @see llvm::Type::isSized()
685 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
688 * Obtain the context to which this type instance is associated.
690 * @see llvm::Type::getContext()
692 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
695 * @defgroup LLVMCCoreTypeInt Integer Types
697 * Functions in this section operate on integer types.
703 * Obtain an integer type from a context with specified bit width.
705 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
706 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
707 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
708 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
709 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
710 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
713 * Obtain an integer type from the global context with a specified bit
716 LLVMTypeRef LLVMInt1Type(void);
717 LLVMTypeRef LLVMInt8Type(void);
718 LLVMTypeRef LLVMInt16Type(void);
719 LLVMTypeRef LLVMInt32Type(void);
720 LLVMTypeRef LLVMInt64Type(void);
721 LLVMTypeRef LLVMIntType(unsigned NumBits);
722 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
729 * @defgroup LLVMCCoreTypeFloat Floating Point Types
735 * Obtain a 16-bit floating point type from a context.
737 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
740 * Obtain a 32-bit floating point type from a context.
742 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
745 * Obtain a 64-bit floating point type from a context.
747 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
750 * Obtain a 80-bit floating point type (X87) from a context.
752 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
755 * Obtain a 128-bit floating point type (112-bit mantissa) from a
758 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
761 * Obtain a 128-bit floating point type (two 64-bits) from a context.
763 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
766 * Obtain a floating point type from the global context.
768 * These map to the functions in this group of the same name.
770 LLVMTypeRef LLVMHalfType(void);
771 LLVMTypeRef LLVMFloatType(void);
772 LLVMTypeRef LLVMDoubleType(void);
773 LLVMTypeRef LLVMX86FP80Type(void);
774 LLVMTypeRef LLVMFP128Type(void);
775 LLVMTypeRef LLVMPPCFP128Type(void);
782 * @defgroup LLVMCCoreTypeFunction Function Types
788 * Obtain a function type consisting of a specified signature.
790 * The function is defined as a tuple of a return Type, a list of
791 * parameter types, and whether the function is variadic.
793 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
794 LLVMTypeRef *ParamTypes, unsigned ParamCount,
798 * Returns whether a function type is variadic.
800 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
803 * Obtain the Type this function Type returns.
805 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
808 * Obtain the number of parameters this function accepts.
810 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
813 * Obtain the types of a function's parameters.
815 * The Dest parameter should point to a pre-allocated array of
816 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
817 * first LLVMCountParamTypes() entries in the array will be populated
818 * with LLVMTypeRef instances.
820 * @param FunctionTy The function type to operate on.
821 * @param Dest Memory address of an array to be filled with result.
823 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
830 * @defgroup LLVMCCoreTypeStruct Structure Types
832 * These functions relate to LLVMTypeRef instances.
834 * @see llvm::StructType
840 * Create a new structure type in a context.
842 * A structure is specified by a list of inner elements/types and
843 * whether these can be packed together.
845 * @see llvm::StructType::create()
847 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
848 unsigned ElementCount, LLVMBool Packed);
851 * Create a new structure type in the global context.
853 * @see llvm::StructType::create()
855 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
859 * Create an empty structure in a context having a specified name.
861 * @see llvm::StructType::create()
863 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
866 * Obtain the name of a structure.
868 * @see llvm::StructType::getName()
870 const char *LLVMGetStructName(LLVMTypeRef Ty);
873 * Set the contents of a structure type.
875 * @see llvm::StructType::setBody()
877 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
878 unsigned ElementCount, LLVMBool Packed);
881 * Get the number of elements defined inside the structure.
883 * @see llvm::StructType::getNumElements()
885 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
888 * Get the elements within a structure.
890 * The function is passed the address of a pre-allocated array of
891 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
892 * invocation, this array will be populated with the structure's
893 * elements. The objects in the destination array will have a lifetime
894 * of the structure type itself, which is the lifetime of the context it
897 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
900 * Determine whether a structure is packed.
902 * @see llvm::StructType::isPacked()
904 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
907 * Determine whether a structure is opaque.
909 * @see llvm::StructType::isOpaque()
911 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
919 * @defgroup LLVMCCoreTypeSequential Sequential Types
921 * Sequential types represents "arrays" of types. This is a super class
922 * for array, vector, and pointer types.
928 * Obtain the type of elements within a sequential type.
930 * This works on array, vector, and pointer types.
932 * @see llvm::SequentialType::getElementType()
934 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
937 * Create a fixed size array type that refers to a specific type.
939 * The created type will exist in the context that its element type
942 * @see llvm::ArrayType::get()
944 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
947 * Obtain the length of an array type.
949 * This only works on types that represent arrays.
951 * @see llvm::ArrayType::getNumElements()
953 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
956 * Create a pointer type that points to a defined type.
958 * The created type will exist in the context that its pointee type
961 * @see llvm::PointerType::get()
963 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
966 * Obtain the address space of a pointer type.
968 * This only works on types that represent pointers.
970 * @see llvm::PointerType::getAddressSpace()
972 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
975 * Create a vector type that contains a defined type and has a specific
976 * number of elements.
978 * The created type will exist in the context thats its element type
981 * @see llvm::VectorType::get()
983 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
986 * Obtain the number of elements in a vector type.
988 * This only works on types that represent vectors.
990 * @see llvm::VectorType::getNumElements()
992 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
999 * @defgroup LLVMCCoreTypeOther Other Types
1005 * Create a void type in a context.
1007 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1010 * Create a label type in a context.
1012 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1015 * Create a X86 MMX type in a context.
1017 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1020 * These are similar to the above functions except they operate on the
1023 LLVMTypeRef LLVMVoidType(void);
1024 LLVMTypeRef LLVMLabelType(void);
1025 LLVMTypeRef LLVMX86MMXType(void);
1036 * @defgroup LLVMCCoreValues Values
1038 * The bulk of LLVM's object model consists of values, which comprise a very
1039 * rich type hierarchy.
1041 * LLVMValueRef essentially represents llvm::Value. There is a rich
1042 * hierarchy of classes within this type. Depending on the instance
1043 * obtained, not all APIs are available.
1045 * Callers can determine the type of an LLVMValueRef by calling the
1046 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1047 * functions are defined by a macro, so it isn't obvious which are
1048 * available by looking at the Doxygen source code. Instead, look at the
1049 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1050 * of value names given. These value names also correspond to classes in
1051 * the llvm::Value hierarchy.
1056 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1064 macro(BlockAddress) \
1065 macro(ConstantAggregateZero) \
1066 macro(ConstantArray) \
1067 macro(ConstantExpr) \
1069 macro(ConstantInt) \
1070 macro(ConstantPointerNull) \
1071 macro(ConstantStruct) \
1072 macro(ConstantVector) \
1073 macro(GlobalValue) \
1075 macro(GlobalAlias) \
1076 macro(GlobalVariable) \
1078 macro(Instruction) \
1079 macro(BinaryOperator) \
1081 macro(IntrinsicInst) \
1082 macro(DbgInfoIntrinsic) \
1083 macro(DbgDeclareInst) \
1084 macro(MemIntrinsic) \
1086 macro(MemMoveInst) \
1091 macro(ExtractElementInst) \
1092 macro(GetElementPtrInst) \
1093 macro(InsertElementInst) \
1094 macro(InsertValueInst) \
1095 macro(LandingPadInst) \
1098 macro(ShuffleVectorInst) \
1100 macro(TerminatorInst) \
1102 macro(IndirectBrInst) \
1106 macro(UnreachableInst) \
1108 macro(UnaryInstruction) \
1111 macro(BitCastInst) \
1115 macro(FPTruncInst) \
1116 macro(IntToPtrInst) \
1117 macro(PtrToIntInst) \
1123 macro(ExtractValueInst) \
1128 * @defgroup LLVMCCoreValueGeneral General APIs
1130 * Functions in this section work on all LLVMValueRef instances,
1131 * regardless of their sub-type. They correspond to functions available
1138 * Obtain the type of a value.
1140 * @see llvm::Value::getType()
1142 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1145 * Obtain the string name of a value.
1147 * @see llvm::Value::getName()
1149 const char *LLVMGetValueName(LLVMValueRef Val);
1152 * Set the string name of a value.
1154 * @see llvm::Value::setName()
1156 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1159 * Dump a representation of a value to stderr.
1161 * @see llvm::Value::dump()
1163 void LLVMDumpValue(LLVMValueRef Val);
1166 * Replace all uses of a value with another one.
1168 * @see llvm::Value::replaceAllUsesWith()
1170 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1173 * Determine whether the specified constant instance is constant.
1175 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1178 * Determine whether a value instance is undefined.
1180 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1183 * Convert value instances between types.
1185 * Internally, an LLVMValueRef is "pinned" to a specific type. This
1186 * series of functions allows you to cast an instance to a specific
1189 * If the cast is not valid for the specified type, NULL is returned.
1191 * @see llvm::dyn_cast_or_null<>
1193 #define LLVM_DECLARE_VALUE_CAST(name) \
1194 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1195 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1202 * @defgroup LLVMCCoreValueUses Usage
1204 * This module defines functions that allow you to inspect the uses of a
1207 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1208 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1209 * llvm::User and llvm::Value.
1215 * Obtain the first use of a value.
1217 * Uses are obtained in an iterator fashion. First, call this function
1218 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1219 * on that instance and all subsequently obtained instances until
1220 * LLVMGetNextUse() returns NULL.
1222 * @see llvm::Value::use_begin()
1224 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1227 * Obtain the next use of a value.
1229 * This effectively advances the iterator. It returns NULL if you are on
1230 * the final use and no more are available.
1232 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1235 * Obtain the user value for a user.
1237 * The returned value corresponds to a llvm::User type.
1239 * @see llvm::Use::getUser()
1241 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1244 * Obtain the value this use corresponds to.
1246 * @see llvm::Use::get().
1248 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1255 * @defgroup LLVMCCoreValueUser User value
1257 * Function in this group pertain to LLVMValueRef instances that descent
1258 * from llvm::User. This includes constants, instructions, and
1265 * Obtain an operand at a specific index in a llvm::User value.
1267 * @see llvm::User::getOperand()
1269 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1272 * Set an operand at a specific index in a llvm::User value.
1274 * @see llvm::User::setOperand()
1276 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1279 * Obtain the number of operands in a llvm::User value.
1281 * @see llvm::User::getNumOperands()
1283 int LLVMGetNumOperands(LLVMValueRef Val);
1290 * @defgroup LLVMCCoreValueConstant Constants
1292 * This section contains APIs for interacting with LLVMValueRef that
1293 * correspond to llvm::Constant instances.
1295 * These functions will work for any LLVMValueRef in the llvm::Constant
1302 * Obtain a constant value referring to the null instance of a type.
1304 * @see llvm::Constant::getNullValue()
1306 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1309 * Obtain a constant value referring to the instance of a type
1310 * consisting of all ones.
1312 * This is only valid for integer types.
1314 * @see llvm::Constant::getAllOnesValue()
1316 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1319 * Obtain a constant value referring to an undefined value of a type.
1321 * @see llvm::UndefValue::get()
1323 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1326 * Determine whether a value instance is null.
1328 * @see llvm::Constant::isNullValue()
1330 LLVMBool LLVMIsNull(LLVMValueRef Val);
1333 * Obtain a constant that is a constant pointer pointing to NULL for a
1336 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1339 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1341 * Functions in this group model LLVMValueRef instances that correspond
1342 * to constants referring to scalar types.
1344 * For integer types, the LLVMTypeRef parameter should correspond to a
1345 * llvm::IntegerType instance and the returned LLVMValueRef will
1346 * correspond to a llvm::ConstantInt.
1348 * For floating point types, the LLVMTypeRef returned corresponds to a
1355 * Obtain a constant value for an integer type.
1357 * The returned value corresponds to a llvm::ConstantInt.
1359 * @see llvm::ConstantInt::get()
1361 * @param IntTy Integer type to obtain value of.
1362 * @param N The value the returned instance should refer to.
1363 * @param SignExtend Whether to sign extend the produced value.
1365 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1366 LLVMBool SignExtend);
1369 * Obtain a constant value for an integer of arbitrary precision.
1371 * @see llvm::ConstantInt::get()
1373 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1375 const uint64_t Words[]);
1378 * Obtain a constant value for an integer parsed from a string.
1380 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1381 * string's length is available, it is preferred to call that function
1384 * @see llvm::ConstantInt::get()
1386 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1390 * Obtain a constant value for an integer parsed from a string with
1393 * @see llvm::ConstantInt::get()
1395 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1396 unsigned SLen, uint8_t Radix);
1399 * Obtain a constant value referring to a double floating point value.
1401 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1404 * Obtain a constant for a floating point value parsed from a string.
1406 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1407 * should be used if the input string's length is known.
1409 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1412 * Obtain a constant for a floating point value parsed from a string.
1414 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1418 * Obtain the zero extended value for an integer constant value.
1420 * @see llvm::ConstantInt::getZExtValue()
1422 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1425 * Obtain the sign extended value for an integer constant value.
1427 * @see llvm::ConstantInt::getSExtValue()
1429 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1436 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1438 * Functions in this group operate on composite constants.
1444 * Create a ConstantDataSequential and initialize it with a string.
1446 * @see llvm::ConstantDataArray::getString()
1448 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1449 unsigned Length, LLVMBool DontNullTerminate);
1452 * Create a ConstantDataSequential with string content in the global context.
1454 * This is the same as LLVMConstStringInContext except it operates on the
1457 * @see LLVMConstStringInContext()
1458 * @see llvm::ConstantDataArray::getString()
1460 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1461 LLVMBool DontNullTerminate);
1464 * Create an anonymous ConstantStruct with the specified values.
1466 * @see llvm::ConstantStruct::getAnon()
1468 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1469 LLVMValueRef *ConstantVals,
1470 unsigned Count, LLVMBool Packed);
1473 * Create a ConstantStruct in the global Context.
1475 * This is the same as LLVMConstStructInContext except it operates on the
1478 * @see LLVMConstStructInContext()
1480 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1484 * Create a ConstantArray from values.
1486 * @see llvm::ConstantArray::get()
1488 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1489 LLVMValueRef *ConstantVals, unsigned Length);
1492 * Create a non-anonymous ConstantStruct from values.
1494 * @see llvm::ConstantStruct::get()
1496 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1497 LLVMValueRef *ConstantVals,
1501 * Create a ConstantVector from values.
1503 * @see llvm::ConstantVector::get()
1505 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1512 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1514 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1516 * @see llvm::ConstantExpr.
1520 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1521 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1522 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1523 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1524 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1525 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1526 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1527 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1528 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1529 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1530 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1531 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1532 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1533 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1534 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1535 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1536 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1537 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1538 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1539 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1540 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1541 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1542 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1543 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1544 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1545 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1546 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1547 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1548 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1549 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1550 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1551 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1552 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1553 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1554 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1555 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1556 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1557 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1558 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1559 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1560 LLVMValueRef *ConstantIndices,
1561 unsigned NumIndices);
1562 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1563 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1564 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1565 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1566 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1567 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1568 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1569 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1570 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1571 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1572 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1573 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1574 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1575 LLVMTypeRef ToType);
1576 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1577 LLVMTypeRef ToType);
1578 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1579 LLVMTypeRef ToType);
1580 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1581 LLVMTypeRef ToType);
1582 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1584 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1585 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1586 LLVMValueRef ConstantIfTrue,
1587 LLVMValueRef ConstantIfFalse);
1588 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1589 LLVMValueRef IndexConstant);
1590 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1591 LLVMValueRef ElementValueConstant,
1592 LLVMValueRef IndexConstant);
1593 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1594 LLVMValueRef VectorBConstant,
1595 LLVMValueRef MaskConstant);
1596 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1598 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1599 LLVMValueRef ElementValueConstant,
1600 unsigned *IdxList, unsigned NumIdx);
1601 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1602 const char *AsmString, const char *Constraints,
1603 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1604 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1611 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1613 * This group contains functions that operate on global values. Functions in
1614 * this group relate to functions in the llvm::GlobalValue class tree.
1616 * @see llvm::GlobalValue
1621 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1622 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1623 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1624 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1625 const char *LLVMGetSection(LLVMValueRef Global);
1626 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1627 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1628 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1629 unsigned LLVMGetAlignment(LLVMValueRef Global);
1630 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
1633 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1635 * This group contains functions that operate on global variable values.
1637 * @see llvm::GlobalVariable
1641 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1642 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1644 unsigned AddressSpace);
1645 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1646 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1647 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1648 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1649 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1650 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1651 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1652 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1653 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1654 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1655 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1656 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1657 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1658 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1659 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1660 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1667 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1669 * This group contains function that operate on global alias values.
1671 * @see llvm::GlobalAlias
1675 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1683 * @defgroup LLVMCCoreValueFunction Function values
1685 * Functions in this group operate on LLVMValueRef instances that
1686 * correspond to llvm::Function instances.
1688 * @see llvm::Function
1694 * Remove a function from its containing module and deletes it.
1696 * @see llvm::Function::eraseFromParent()
1698 void LLVMDeleteFunction(LLVMValueRef Fn);
1701 * Obtain the ID number from a function instance.
1703 * @see llvm::Function::getIntrinsicID()
1705 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1708 * Obtain the calling function of a function.
1710 * The returned value corresponds to the LLVMCallConv enumeration.
1712 * @see llvm::Function::getCallingConv()
1714 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1717 * Set the calling convention of a function.
1719 * @see llvm::Function::setCallingConv()
1721 * @param Fn Function to operate on
1722 * @param CC LLVMCallConv to set calling convention to
1724 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1727 * Obtain the name of the garbage collector to use during code
1730 * @see llvm::Function::getGC()
1732 const char *LLVMGetGC(LLVMValueRef Fn);
1735 * Define the garbage collector to use during code generation.
1737 * @see llvm::Function::setGC()
1739 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1742 * Add an attribute to a function.
1744 * @see llvm::Function::addAttribute()
1746 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1749 * Add a target-dependent attribute to a fuction
1750 * @see llvm::AttrBuilder::addAttribute()
1752 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1756 * Obtain an attribute from a function.
1758 * @see llvm::Function::getAttributes()
1760 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1763 * Remove an attribute from a function.
1765 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1768 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1770 * Functions in this group relate to arguments/parameters on functions.
1772 * Functions in this group expect LLVMValueRef instances that correspond
1773 * to llvm::Function instances.
1779 * Obtain the number of parameters in a function.
1781 * @see llvm::Function::arg_size()
1783 unsigned LLVMCountParams(LLVMValueRef Fn);
1786 * Obtain the parameters in a function.
1788 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1789 * at least LLVMCountParams() long. This array will be filled with
1790 * LLVMValueRef instances which correspond to the parameters the
1791 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1794 * @see llvm::Function::arg_begin()
1796 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1799 * Obtain the parameter at the specified index.
1801 * Parameters are indexed from 0.
1803 * @see llvm::Function::arg_begin()
1805 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1808 * Obtain the function to which this argument belongs.
1810 * Unlike other functions in this group, this one takes an LLVMValueRef
1811 * that corresponds to a llvm::Attribute.
1813 * The returned LLVMValueRef is the llvm::Function to which this
1816 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1819 * Obtain the first parameter to a function.
1821 * @see llvm::Function::arg_begin()
1823 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1826 * Obtain the last parameter to a function.
1828 * @see llvm::Function::arg_end()
1830 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
1833 * Obtain the next parameter to a function.
1835 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
1836 * actually a wrapped iterator) and obtains the next parameter from the
1837 * underlying iterator.
1839 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
1842 * Obtain the previous parameter to a function.
1844 * This is the opposite of LLVMGetNextParam().
1846 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
1849 * Add an attribute to a function argument.
1851 * @see llvm::Argument::addAttr()
1853 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1856 * Remove an attribute from a function argument.
1858 * @see llvm::Argument::removeAttr()
1860 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1863 * Get an attribute from a function argument.
1865 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
1868 * Set the alignment for a function parameter.
1870 * @see llvm::Argument::addAttr()
1871 * @see llvm::AttrBuilder::addAlignmentAttr()
1873 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
1892 * @defgroup LLVMCCoreValueMetadata Metadata
1898 * Obtain a MDString value from a context.
1900 * The returned instance corresponds to the llvm::MDString class.
1902 * The instance is specified by string data of a specified length. The
1903 * string content is copied, so the backing memory can be freed after
1904 * this function returns.
1906 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
1910 * Obtain a MDString value from the global context.
1912 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
1915 * Obtain a MDNode value from a context.
1917 * The returned value corresponds to the llvm::MDNode class.
1919 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
1923 * Obtain a MDNode value from the global context.
1925 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
1928 * Obtain the underlying string from a MDString value.
1930 * @param V Instance to obtain string from.
1931 * @param Len Memory address which will hold length of returned string.
1932 * @return String data in MDString.
1934 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
1937 * Obtain the number of operands from an MDNode value.
1939 * @param V MDNode to get number of operands from.
1940 * @return Number of operands of the MDNode.
1942 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
1945 * Obtain the given MDNode's operands.
1947 * The passed LLVMValueRef pointer should point to enough memory to hold all of
1948 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
1949 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
1950 * MDNode's operands.
1952 * @param V MDNode to get the operands from.
1953 * @param Dest Destination array for operands.
1955 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
1962 * @defgroup LLVMCCoreValueBasicBlock Basic Block
1964 * A basic block represents a single entry single exit section of code.
1965 * Basic blocks contain a list of instructions which form the body of
1968 * Basic blocks belong to functions. They have the type of label.
1970 * Basic blocks are themselves values. However, the C API models them as
1971 * LLVMBasicBlockRef.
1973 * @see llvm::BasicBlock
1979 * Convert a basic block instance to a value type.
1981 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
1984 * Determine whether an LLVMValueRef is itself a basic block.
1986 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
1989 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
1991 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
1994 * Obtain the function to which a basic block belongs.
1996 * @see llvm::BasicBlock::getParent()
1998 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2001 * Obtain the terminator instruction for a basic block.
2003 * If the basic block does not have a terminator (it is not well-formed
2004 * if it doesn't), then NULL is returned.
2006 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2008 * @see llvm::BasicBlock::getTerminator()
2010 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2013 * Obtain the number of basic blocks in a function.
2015 * @param Fn Function value to operate on.
2017 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2020 * Obtain all of the basic blocks in a function.
2022 * This operates on a function value. The BasicBlocks parameter is a
2023 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2024 * LLVMCountBasicBlocks() in length. This array is populated with
2025 * LLVMBasicBlockRef instances.
2027 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2030 * Obtain the first basic block in a function.
2032 * The returned basic block can be used as an iterator. You will likely
2033 * eventually call into LLVMGetNextBasicBlock() with it.
2035 * @see llvm::Function::begin()
2037 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2040 * Obtain the last basic block in a function.
2042 * @see llvm::Function::end()
2044 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2047 * Advance a basic block iterator.
2049 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2052 * Go backwards in a basic block iterator.
2054 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2057 * Obtain the basic block that corresponds to the entry point of a
2060 * @see llvm::Function::getEntryBlock()
2062 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2065 * Append a basic block to the end of a function.
2067 * @see llvm::BasicBlock::Create()
2069 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2074 * Append a basic block to the end of a function using the global
2077 * @see llvm::BasicBlock::Create()
2079 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2082 * Insert a basic block in a function before another basic block.
2084 * The function to add to is determined by the function of the
2085 * passed basic block.
2087 * @see llvm::BasicBlock::Create()
2089 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2090 LLVMBasicBlockRef BB,
2094 * Insert a basic block in a function using the global context.
2096 * @see llvm::BasicBlock::Create()
2098 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2102 * Remove a basic block from a function and delete it.
2104 * This deletes the basic block from its containing function and deletes
2105 * the basic block itself.
2107 * @see llvm::BasicBlock::eraseFromParent()
2109 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2112 * Remove a basic block from a function.
2114 * This deletes the basic block from its containing function but keep
2115 * the basic block alive.
2117 * @see llvm::BasicBlock::removeFromParent()
2119 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2122 * Move a basic block to before another one.
2124 * @see llvm::BasicBlock::moveBefore()
2126 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2129 * Move a basic block to after another one.
2131 * @see llvm::BasicBlock::moveAfter()
2133 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2136 * Obtain the first instruction in a basic block.
2138 * The returned LLVMValueRef corresponds to a llvm::Instruction
2141 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2144 * Obtain the last instruction in a basic block.
2146 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2148 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2155 * @defgroup LLVMCCoreValueInstruction Instructions
2157 * Functions in this group relate to the inspection and manipulation of
2158 * individual instructions.
2160 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2161 * class has a large number of descendents. llvm::Instruction is a
2162 * llvm::Value and in the C API, instructions are modeled by
2165 * This group also contains sub-groups which operate on specific
2166 * llvm::Instruction types, e.g. llvm::CallInst.
2172 * Determine whether an instruction has any metadata attached.
2174 int LLVMHasMetadata(LLVMValueRef Val);
2177 * Return metadata associated with an instruction value.
2179 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2182 * Set metadata associated with an instruction value.
2184 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2187 * Obtain the basic block to which an instruction belongs.
2189 * @see llvm::Instruction::getParent()
2191 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2194 * Obtain the instruction that occurs after the one specified.
2196 * The next instruction will be from the same basic block.
2198 * If this is the last instruction in a basic block, NULL will be
2201 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2204 * Obtain the instruction that occurred before this one.
2206 * If the instruction is the first instruction in a basic block, NULL
2209 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2212 * Remove and delete an instruction.
2214 * The instruction specified is removed from its containing building
2215 * block and then deleted.
2217 * @see llvm::Instruction::eraseFromParent()
2219 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2222 * Obtain the code opcode for an individual instruction.
2224 * @see llvm::Instruction::getOpCode()
2226 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2229 * Obtain the predicate of an instruction.
2231 * This is only valid for instructions that correspond to llvm::ICmpInst
2232 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2234 * @see llvm::ICmpInst::getPredicate()
2236 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2239 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2241 * Functions in this group apply to instructions that refer to call
2242 * sites and invocations. These correspond to C++ types in the
2243 * llvm::CallInst class tree.
2249 * Set the calling convention for a call instruction.
2251 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2254 * @see llvm::CallInst::setCallingConv()
2255 * @see llvm::InvokeInst::setCallingConv()
2257 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2260 * Obtain the calling convention for a call instruction.
2262 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2265 * @see LLVMSetInstructionCallConv()
2267 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2270 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2271 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2273 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2277 * Obtain whether a call instruction is a tail call.
2279 * This only works on llvm::CallInst instructions.
2281 * @see llvm::CallInst::isTailCall()
2283 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2286 * Set whether a call instruction is a tail call.
2288 * This only works on llvm::CallInst instructions.
2290 * @see llvm::CallInst::setTailCall()
2292 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2299 * Obtain the default destination basic block of a switch instruction.
2301 * This only works on llvm::SwitchInst instructions.
2303 * @see llvm::SwitchInst::getDefaultDest()
2305 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2308 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2310 * Functions in this group only apply to instructions that map to
2311 * llvm::PHINode instances.
2317 * Add an incoming value to the end of a PHI list.
2319 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2320 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2323 * Obtain the number of incoming basic blocks to a PHI node.
2325 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2328 * Obtain an incoming value to a PHI node as an LLVMValueRef.
2330 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2333 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2335 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2350 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2352 * An instruction builder represents a point within a basic block and is
2353 * the exclusive means of building instructions using the C interface.
2358 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2359 LLVMBuilderRef LLVMCreateBuilder(void);
2360 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2361 LLVMValueRef Instr);
2362 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2363 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2364 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2365 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2366 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2367 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2369 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2372 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2373 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2374 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2377 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2378 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2379 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2381 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2382 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2383 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2384 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2385 LLVMBasicBlockRef Else, unsigned NumCases);
2386 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2388 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2389 LLVMValueRef *Args, unsigned NumArgs,
2390 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2392 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2393 LLVMValueRef PersFn, unsigned NumClauses,
2395 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2396 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2398 /* Add a case to the switch instruction */
2399 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2400 LLVMBasicBlockRef Dest);
2402 /* Add a destination to the indirectbr instruction */
2403 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2405 /* Add a catch or filter clause to the landingpad instruction */
2406 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2408 /* Set the 'cleanup' flag in the landingpad instruction */
2409 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2412 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2414 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2416 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2418 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2420 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2422 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2424 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2426 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2428 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2430 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2432 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2434 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2436 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2438 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2440 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2442 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2444 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2446 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2448 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2450 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2452 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2454 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2456 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2458 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2460 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2462 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2463 LLVMValueRef LHS, LLVMValueRef RHS,
2465 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2466 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2468 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2470 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2471 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2474 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2475 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2476 LLVMValueRef Val, const char *Name);
2477 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2478 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2479 LLVMValueRef Val, const char *Name);
2480 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2481 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2483 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2484 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2485 LLVMValueRef *Indices, unsigned NumIndices,
2487 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2488 LLVMValueRef *Indices, unsigned NumIndices,
2490 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2491 unsigned Idx, const char *Name);
2492 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2494 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2496 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2497 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2500 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2501 LLVMTypeRef DestTy, const char *Name);
2502 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2503 LLVMTypeRef DestTy, const char *Name);
2504 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2505 LLVMTypeRef DestTy, const char *Name);
2506 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2507 LLVMTypeRef DestTy, const char *Name);
2508 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2509 LLVMTypeRef DestTy, const char *Name);
2510 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2511 LLVMTypeRef DestTy, const char *Name);
2512 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2513 LLVMTypeRef DestTy, const char *Name);
2514 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2515 LLVMTypeRef DestTy, const char *Name);
2516 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2517 LLVMTypeRef DestTy, const char *Name);
2518 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2519 LLVMTypeRef DestTy, const char *Name);
2520 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2521 LLVMTypeRef DestTy, const char *Name);
2522 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2523 LLVMTypeRef DestTy, const char *Name);
2524 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2525 LLVMTypeRef DestTy, const char *Name);
2526 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2527 LLVMTypeRef DestTy, const char *Name);
2528 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2529 LLVMTypeRef DestTy, const char *Name);
2530 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2531 LLVMTypeRef DestTy, const char *Name);
2532 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2533 LLVMTypeRef DestTy, const char *Name);
2534 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2535 LLVMTypeRef DestTy, const char *Name);
2536 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2537 LLVMTypeRef DestTy, const char *Name);
2540 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2541 LLVMValueRef LHS, LLVMValueRef RHS,
2543 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2544 LLVMValueRef LHS, LLVMValueRef RHS,
2547 /* Miscellaneous instructions */
2548 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2549 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2550 LLVMValueRef *Args, unsigned NumArgs,
2552 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2553 LLVMValueRef Then, LLVMValueRef Else,
2555 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2557 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2558 LLVMValueRef Index, const char *Name);
2559 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2560 LLVMValueRef EltVal, LLVMValueRef Index,
2562 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2563 LLVMValueRef V2, LLVMValueRef Mask,
2565 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2566 unsigned Index, const char *Name);
2567 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2568 LLVMValueRef EltVal, unsigned Index,
2571 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2573 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2575 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2576 LLVMValueRef RHS, const char *Name);
2577 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B,LLVMAtomicRMWBinOp op,
2578 LLVMValueRef PTR, LLVMValueRef Val,
2579 LLVMAtomicOrdering ordering,
2580 LLVMBool singleThread);
2587 * @defgroup LLVMCCoreModuleProvider Module Providers
2593 * Changes the type of M so it can be passed to FunctionPassManagers and the
2594 * JIT. They take ModuleProviders for historical reasons.
2596 LLVMModuleProviderRef
2597 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2600 * Destroys the module M.
2602 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2609 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2614 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2615 LLVMMemoryBufferRef *OutMemBuf,
2617 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2619 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2620 size_t InputDataLength,
2621 const char *BufferName,
2622 LLVMBool RequiresNullTerminator);
2623 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2624 size_t InputDataLength,
2625 const char *BufferName);
2626 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2627 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2628 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2635 * @defgroup LLVMCCorePassRegistry Pass Registry
2640 /** Return the global pass registry, for use with initialization functions.
2641 @see llvm::PassRegistry::getPassRegistry */
2642 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2649 * @defgroup LLVMCCorePassManagers Pass Managers
2654 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2655 suitable for link-time optimization and whole-module transformations.
2656 @see llvm::PassManager::PassManager */
2657 LLVMPassManagerRef LLVMCreatePassManager(void);
2659 /** Constructs a new function-by-function pass pipeline over the module
2660 provider. It does not take ownership of the module provider. This type of
2661 pipeline is suitable for code generation and JIT compilation tasks.
2662 @see llvm::FunctionPassManager::FunctionPassManager */
2663 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2665 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2666 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2668 /** Initializes, executes on the provided module, and finalizes all of the
2669 passes scheduled in the pass manager. Returns 1 if any of the passes
2670 modified the module, 0 otherwise.
2671 @see llvm::PassManager::run(Module&) */
2672 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2674 /** Initializes all of the function passes scheduled in the function pass
2675 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2676 @see llvm::FunctionPassManager::doInitialization */
2677 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2679 /** Executes all of the function passes scheduled in the function pass manager
2680 on the provided function. Returns 1 if any of the passes modified the
2681 function, false otherwise.
2682 @see llvm::FunctionPassManager::run(Function&) */
2683 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2685 /** Finalizes all of the function passes scheduled in in the function pass
2686 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2687 @see llvm::FunctionPassManager::doFinalization */
2688 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2690 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2691 the module provider.
2692 @see llvm::PassManagerBase::~PassManagerBase. */
2693 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2700 * @defgroup LLVMCCoreThreading Threading
2702 * Handle the structures needed to make LLVM safe for multithreading.
2707 /** Allocate and initialize structures needed to make LLVM safe for
2708 multithreading. The return value indicates whether multithreaded
2709 initialization succeeded. Must be executed in isolation from all
2710 other LLVM api calls.
2711 @see llvm::llvm_start_multithreaded */
2712 LLVMBool LLVMStartMultithreaded();
2714 /** Deallocate structures necessary to make LLVM safe for multithreading.
2715 Must be executed in isolation from all other LLVM api calls.
2716 @see llvm::llvm_stop_multithreaded */
2717 void LLVMStopMultithreaded();
2719 /** Check whether LLVM is executing in thread-safe mode or not.
2720 @see llvm::llvm_is_multithreaded */
2721 LLVMBool LLVMIsMultithreaded();
2737 #endif /* !defined(__cplusplus) */
2739 #endif /* !defined(LLVM_C_CORE_H) */