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-c/Support.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
68 * The top-level container for all LLVM global data. See the LLVMContext class.
70 typedef struct LLVMOpaqueContext *LLVMContextRef;
73 * The top-level container for all other LLVM Intermediate Representation (IR)
78 typedef struct LLVMOpaqueModule *LLVMModuleRef;
81 * Each value in the LLVM IR has a type, an LLVMTypeRef.
85 typedef struct LLVMOpaqueType *LLVMTypeRef;
88 * Represents an individual value in LLVM IR.
90 * This models llvm::Value.
92 typedef struct LLVMOpaqueValue *LLVMValueRef;
95 * Represents a basic block of instructions in LLVM IR.
97 * This models llvm::BasicBlock.
99 typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
102 * Represents an LLVM basic block builder.
104 * This models llvm::IRBuilder.
106 typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
109 * Interface used to provide a module to JIT or interpreter.
110 * This is now just a synonym for llvm::Module, but we have to keep using the
111 * different type to keep binary compatibility.
113 typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
115 /** @see llvm::PassManagerBase */
116 typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
118 /** @see llvm::PassRegistry */
119 typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef;
122 * Used to get the users and usees of a Value.
125 typedef struct LLVMOpaqueUse *LLVMUseRef;
128 LLVMZExtAttribute = 1<<0,
129 LLVMSExtAttribute = 1<<1,
130 LLVMNoReturnAttribute = 1<<2,
131 LLVMInRegAttribute = 1<<3,
132 LLVMStructRetAttribute = 1<<4,
133 LLVMNoUnwindAttribute = 1<<5,
134 LLVMNoAliasAttribute = 1<<6,
135 LLVMByValAttribute = 1<<7,
136 LLVMNestAttribute = 1<<8,
137 LLVMReadNoneAttribute = 1<<9,
138 LLVMReadOnlyAttribute = 1<<10,
139 LLVMNoInlineAttribute = 1<<11,
140 LLVMAlwaysInlineAttribute = 1<<12,
141 LLVMOptimizeForSizeAttribute = 1<<13,
142 LLVMStackProtectAttribute = 1<<14,
143 LLVMStackProtectReqAttribute = 1<<15,
144 LLVMAlignment = 31<<16,
145 LLVMNoCaptureAttribute = 1<<21,
146 LLVMNoRedZoneAttribute = 1<<22,
147 LLVMNoImplicitFloatAttribute = 1<<23,
148 LLVMNakedAttribute = 1<<24,
149 LLVMInlineHintAttribute = 1<<25,
150 LLVMStackAlignment = 7<<26,
151 LLVMReturnsTwice = 1 << 29,
152 LLVMUWTable = 1 << 30,
153 LLVMNonLazyBind = 1 << 31
155 /* FIXME: These attributes are currently not included in the C API as
156 a temporary measure until the API/ABI impact to the C API is understood
157 and the path forward agreed upon.
158 LLVMAddressSafety = 1ULL << 32,
159 LLVMStackProtectStrongAttribute = 1ULL<<33,
160 LLVMCold = 1ULL << 34,
161 LLVMOptimizeNone = 1ULL << 35,
162 LLVMInAllocaAttribute = 1ULL << 36
167 /* Terminator Instructions */
173 /* removed 6 due to API changes */
176 /* Standard Binary Operators */
190 /* Logical Operators */
198 /* Memory Operators */
202 LLVMGetElementPtr = 29,
217 LLVMAddrSpaceCast = 60,
219 /* Other Operators */
228 LLVMExtractElement = 50,
229 LLVMInsertElement = 51,
230 LLVMShuffleVector = 52,
231 LLVMExtractValue = 53,
232 LLVMInsertValue = 54,
234 /* Atomic operators */
236 LLVMAtomicCmpXchg = 56,
239 /* Exception Handling Operators */
246 LLVMVoidTypeKind, /**< type with no size */
247 LLVMHalfTypeKind, /**< 16 bit floating point type */
248 LLVMFloatTypeKind, /**< 32 bit floating point type */
249 LLVMDoubleTypeKind, /**< 64 bit floating point type */
250 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
251 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
252 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
253 LLVMLabelTypeKind, /**< Labels */
254 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
255 LLVMFunctionTypeKind, /**< Functions */
256 LLVMStructTypeKind, /**< Structures */
257 LLVMArrayTypeKind, /**< Arrays */
258 LLVMPointerTypeKind, /**< Pointers */
259 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
260 LLVMMetadataTypeKind, /**< Metadata */
261 LLVMX86_MMXTypeKind /**< X86 MMX */
265 LLVMExternalLinkage, /**< Externally visible function */
266 LLVMAvailableExternallyLinkage,
267 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
268 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
270 LLVMLinkOnceODRAutoHideLinkage, /**< Obsolete */
271 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
272 LLVMWeakODRLinkage, /**< Same, but only replaced by something
274 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
275 LLVMInternalLinkage, /**< Rename collisions when linking (static
277 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
278 LLVMDLLImportLinkage, /**< Obsolete */
279 LLVMDLLExportLinkage, /**< Obsolete */
280 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
281 LLVMGhostLinkage, /**< Obsolete */
282 LLVMCommonLinkage, /**< Tentative definitions */
283 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
284 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
288 LLVMDefaultVisibility, /**< The GV is visible */
289 LLVMHiddenVisibility, /**< The GV is hidden */
290 LLVMProtectedVisibility /**< The GV is protected */
294 LLVMDefaultStorageClass = 0,
295 LLVMDLLImportStorageClass = 1, /**< Function to be imported from DLL. */
296 LLVMDLLExportStorageClass = 2 /**< Function to be accessible from DLL. */
297 } LLVMDLLStorageClass;
301 LLVMFastCallConv = 8,
302 LLVMColdCallConv = 9,
303 LLVMWebKitJSCallConv = 12,
304 LLVMAnyRegCallConv = 13,
305 LLVMX86StdcallCallConv = 64,
306 LLVMX86FastcallCallConv = 65
310 LLVMIntEQ = 32, /**< equal */
311 LLVMIntNE, /**< not equal */
312 LLVMIntUGT, /**< unsigned greater than */
313 LLVMIntUGE, /**< unsigned greater or equal */
314 LLVMIntULT, /**< unsigned less than */
315 LLVMIntULE, /**< unsigned less or equal */
316 LLVMIntSGT, /**< signed greater than */
317 LLVMIntSGE, /**< signed greater or equal */
318 LLVMIntSLT, /**< signed less than */
319 LLVMIntSLE /**< signed less or equal */
323 LLVMRealPredicateFalse, /**< Always false (always folded) */
324 LLVMRealOEQ, /**< True if ordered and equal */
325 LLVMRealOGT, /**< True if ordered and greater than */
326 LLVMRealOGE, /**< True if ordered and greater than or equal */
327 LLVMRealOLT, /**< True if ordered and less than */
328 LLVMRealOLE, /**< True if ordered and less than or equal */
329 LLVMRealONE, /**< True if ordered and operands are unequal */
330 LLVMRealORD, /**< True if ordered (no nans) */
331 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
332 LLVMRealUEQ, /**< True if unordered or equal */
333 LLVMRealUGT, /**< True if unordered or greater than */
334 LLVMRealUGE, /**< True if unordered, greater than, or equal */
335 LLVMRealULT, /**< True if unordered or less than */
336 LLVMRealULE, /**< True if unordered, less than, or equal */
337 LLVMRealUNE, /**< True if unordered or not equal */
338 LLVMRealPredicateTrue /**< Always true (always folded) */
342 LLVMLandingPadCatch, /**< A catch clause */
343 LLVMLandingPadFilter /**< A filter clause */
344 } LLVMLandingPadClauseTy;
347 LLVMNotThreadLocal = 0,
348 LLVMGeneralDynamicTLSModel,
349 LLVMLocalDynamicTLSModel,
350 LLVMInitialExecTLSModel,
351 LLVMLocalExecTLSModel
352 } LLVMThreadLocalMode;
355 LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */
356 LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees
357 somewhat sane results, lock free. */
358 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the
359 operations affecting a specific address,
360 a consistent ordering exists */
361 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort
362 necessary to acquire a lock to access other
363 memory with normal loads and stores. */
364 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with
365 a barrier of the sort necessary to release
367 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
368 Release barrier (for fences and
369 operations which both read and write
371 LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics
372 for loads and Release
373 semantics for stores.
374 Additionally, it guarantees
375 that a total ordering exists
377 SequentiallyConsistent
379 } LLVMAtomicOrdering;
382 LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */
383 LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */
384 LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */
385 LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */
386 LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */
387 LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */
388 LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */
389 LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the
390 original using a signed comparison and return
392 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
393 original using a signed comparison and return
395 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
396 original using an unsigned comparison and return
398 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
399 original using an unsigned comparison and return
401 } LLVMAtomicRMWBinOp;
407 void LLVMInitializeCore(LLVMPassRegistryRef R);
409 /** Deallocate and destroy all ManagedStatic variables.
410 @see llvm::llvm_shutdown
411 @see ManagedStatic */
412 void LLVMShutdown(void);
415 /*===-- Error handling ----------------------------------------------------===*/
417 char *LLVMCreateMessage(const char *Message);
418 void LLVMDisposeMessage(char *Message);
420 typedef void (*LLVMFatalErrorHandler)(const char *Reason);
423 * Install a fatal error handler. By default, if LLVM detects a fatal error, it
424 * will call exit(1). This may not be appropriate in many contexts. For example,
425 * doing exit(1) will bypass many crash reporting/tracing system tools. This
426 * function allows you to install a callback that will be invoked prior to the
429 void LLVMInstallFatalErrorHandler(LLVMFatalErrorHandler Handler);
432 * Reset the fatal error handler. This resets LLVM's fatal error handling
433 * behavior to the default.
435 void LLVMResetFatalErrorHandler(void);
438 * Enable LLVM's built-in stack trace code. This intercepts the OS's crash
439 * signals and prints which component of LLVM you were in at the time if the
442 void LLVMEnablePrettyStackTrace(void);
445 * @defgroup LLVMCCoreContext Contexts
447 * Contexts are execution states for the core LLVM IR system.
449 * Most types are tied to a context instance. Multiple contexts can
450 * exist simultaneously. A single context is not thread safe. However,
451 * different contexts can execute on different threads simultaneously.
457 * Create a new context.
459 * Every call to this function should be paired with a call to
460 * LLVMContextDispose() or the context will leak memory.
462 LLVMContextRef LLVMContextCreate(void);
465 * Obtain the global context instance.
467 LLVMContextRef LLVMGetGlobalContext(void);
470 * Destroy a context instance.
472 * This should be called for every call to LLVMContextCreate() or memory
475 void LLVMContextDispose(LLVMContextRef C);
477 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
479 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
486 * @defgroup LLVMCCoreModule Modules
488 * Modules represent the top-level structure in an LLVM program. An LLVM
489 * module is effectively a translation unit or a collection of
490 * translation units merged together.
496 * Create a new, empty module in the global context.
498 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
499 * LLVMGetGlobalContext() as the context parameter.
501 * Every invocation should be paired with LLVMDisposeModule() or memory
504 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
507 * Create a new, empty module in a specific context.
509 * Every invocation should be paired with LLVMDisposeModule() or memory
512 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
516 * Destroy a module instance.
518 * This must be called for every created module or memory will be
521 void LLVMDisposeModule(LLVMModuleRef M);
524 * Obtain the data layout for a module.
526 * @see Module::getDataLayout()
528 const char *LLVMGetDataLayout(LLVMModuleRef M);
531 * Set the data layout for a module.
533 * @see Module::setDataLayout()
535 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
538 * Obtain the target triple for a module.
540 * @see Module::getTargetTriple()
542 const char *LLVMGetTarget(LLVMModuleRef M);
545 * Set the target triple for a module.
547 * @see Module::setTargetTriple()
549 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
552 * Dump a representation of a module to stderr.
554 * @see Module::dump()
556 void LLVMDumpModule(LLVMModuleRef M);
559 * Print a representation of a module to a file. The ErrorMessage needs to be
560 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
562 * @see Module::print()
564 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
565 char **ErrorMessage);
568 * Return a string representation of the module. Use
569 * LLVMDisposeMessage to free the string.
571 * @see Module::print()
573 char *LLVMPrintModuleToString(LLVMModuleRef M);
576 * Set inline assembly for a module.
578 * @see Module::setModuleInlineAsm()
580 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
583 * Obtain the context to which this module is associated.
585 * @see Module::getContext()
587 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
590 * Obtain a Type from a module by its registered name.
592 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
595 * Obtain the number of operands for named metadata in a module.
597 * @see llvm::Module::getNamedMetadata()
599 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
602 * Obtain the named metadata operands for a module.
604 * The passed LLVMValueRef pointer should refer to an array of
605 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
606 * array will be populated with the LLVMValueRef instances. Each
607 * instance corresponds to a llvm::MDNode.
609 * @see llvm::Module::getNamedMetadata()
610 * @see llvm::MDNode::getOperand()
612 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
615 * Add an operand to named metadata.
617 * @see llvm::Module::getNamedMetadata()
618 * @see llvm::MDNode::addOperand()
620 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
624 * Add a function to a module under a specified name.
626 * @see llvm::Function::Create()
628 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
629 LLVMTypeRef FunctionTy);
632 * Obtain a Function value from a Module by its name.
634 * The returned value corresponds to a llvm::Function value.
636 * @see llvm::Module::getFunction()
638 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
641 * Obtain an iterator to the first Function in a Module.
643 * @see llvm::Module::begin()
645 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
648 * Obtain an iterator to the last Function in a Module.
650 * @see llvm::Module::end()
652 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
655 * Advance a Function iterator to the next Function.
657 * Returns NULL if the iterator was already at the end and there are no more
660 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
663 * Decrement a Function iterator to the previous Function.
665 * Returns NULL if the iterator was already at the beginning and there are
666 * no previous functions.
668 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
675 * @defgroup LLVMCCoreType Types
677 * Types represent the type of a value.
679 * Types are associated with a context instance. The context internally
680 * deduplicates types so there is only 1 instance of a specific type
681 * alive at a time. In other words, a unique type is shared among all
682 * consumers within a context.
684 * A Type in the C API corresponds to llvm::Type.
686 * Types have the following hierarchy:
704 * Obtain the enumerated type of a Type instance.
706 * @see llvm::Type:getTypeID()
708 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
711 * Whether the type has a known size.
713 * Things that don't have a size are abstract types, labels, and void.a
715 * @see llvm::Type::isSized()
717 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
720 * Obtain the context to which this type instance is associated.
722 * @see llvm::Type::getContext()
724 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
727 * Dump a representation of a type to stderr.
729 * @see llvm::Type::dump()
731 void LLVMDumpType(LLVMTypeRef Val);
734 * Return a string representation of the type. Use
735 * LLVMDisposeMessage to free the string.
737 * @see llvm::Type::print()
739 char *LLVMPrintTypeToString(LLVMTypeRef Val);
742 * @defgroup LLVMCCoreTypeInt Integer Types
744 * Functions in this section operate on integer types.
750 * Obtain an integer type from a context with specified bit width.
752 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
753 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
754 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
755 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
756 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
757 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
760 * Obtain an integer type from the global context with a specified bit
763 LLVMTypeRef LLVMInt1Type(void);
764 LLVMTypeRef LLVMInt8Type(void);
765 LLVMTypeRef LLVMInt16Type(void);
766 LLVMTypeRef LLVMInt32Type(void);
767 LLVMTypeRef LLVMInt64Type(void);
768 LLVMTypeRef LLVMIntType(unsigned NumBits);
769 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
776 * @defgroup LLVMCCoreTypeFloat Floating Point Types
782 * Obtain a 16-bit floating point type from a context.
784 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
787 * Obtain a 32-bit floating point type from a context.
789 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
792 * Obtain a 64-bit floating point type from a context.
794 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
797 * Obtain a 80-bit floating point type (X87) from a context.
799 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
802 * Obtain a 128-bit floating point type (112-bit mantissa) from a
805 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
808 * Obtain a 128-bit floating point type (two 64-bits) from a context.
810 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
813 * Obtain a floating point type from the global context.
815 * These map to the functions in this group of the same name.
817 LLVMTypeRef LLVMHalfType(void);
818 LLVMTypeRef LLVMFloatType(void);
819 LLVMTypeRef LLVMDoubleType(void);
820 LLVMTypeRef LLVMX86FP80Type(void);
821 LLVMTypeRef LLVMFP128Type(void);
822 LLVMTypeRef LLVMPPCFP128Type(void);
829 * @defgroup LLVMCCoreTypeFunction Function Types
835 * Obtain a function type consisting of a specified signature.
837 * The function is defined as a tuple of a return Type, a list of
838 * parameter types, and whether the function is variadic.
840 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
841 LLVMTypeRef *ParamTypes, unsigned ParamCount,
845 * Returns whether a function type is variadic.
847 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
850 * Obtain the Type this function Type returns.
852 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
855 * Obtain the number of parameters this function accepts.
857 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
860 * Obtain the types of a function's parameters.
862 * The Dest parameter should point to a pre-allocated array of
863 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
864 * first LLVMCountParamTypes() entries in the array will be populated
865 * with LLVMTypeRef instances.
867 * @param FunctionTy The function type to operate on.
868 * @param Dest Memory address of an array to be filled with result.
870 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
877 * @defgroup LLVMCCoreTypeStruct Structure Types
879 * These functions relate to LLVMTypeRef instances.
881 * @see llvm::StructType
887 * Create a new structure type in a context.
889 * A structure is specified by a list of inner elements/types and
890 * whether these can be packed together.
892 * @see llvm::StructType::create()
894 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
895 unsigned ElementCount, LLVMBool Packed);
898 * Create a new structure type in the global context.
900 * @see llvm::StructType::create()
902 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
906 * Create an empty structure in a context having a specified name.
908 * @see llvm::StructType::create()
910 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
913 * Obtain the name of a structure.
915 * @see llvm::StructType::getName()
917 const char *LLVMGetStructName(LLVMTypeRef Ty);
920 * Set the contents of a structure type.
922 * @see llvm::StructType::setBody()
924 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
925 unsigned ElementCount, LLVMBool Packed);
928 * Get the number of elements defined inside the structure.
930 * @see llvm::StructType::getNumElements()
932 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
935 * Get the elements within a structure.
937 * The function is passed the address of a pre-allocated array of
938 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
939 * invocation, this array will be populated with the structure's
940 * elements. The objects in the destination array will have a lifetime
941 * of the structure type itself, which is the lifetime of the context it
944 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
947 * Determine whether a structure is packed.
949 * @see llvm::StructType::isPacked()
951 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
954 * Determine whether a structure is opaque.
956 * @see llvm::StructType::isOpaque()
958 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
966 * @defgroup LLVMCCoreTypeSequential Sequential Types
968 * Sequential types represents "arrays" of types. This is a super class
969 * for array, vector, and pointer types.
975 * Obtain the type of elements within a sequential type.
977 * This works on array, vector, and pointer types.
979 * @see llvm::SequentialType::getElementType()
981 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
984 * Create a fixed size array type that refers to a specific type.
986 * The created type will exist in the context that its element type
989 * @see llvm::ArrayType::get()
991 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
994 * Obtain the length of an array type.
996 * This only works on types that represent arrays.
998 * @see llvm::ArrayType::getNumElements()
1000 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
1003 * Create a pointer type that points to a defined type.
1005 * The created type will exist in the context that its pointee type
1008 * @see llvm::PointerType::get()
1010 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
1013 * Obtain the address space of a pointer type.
1015 * This only works on types that represent pointers.
1017 * @see llvm::PointerType::getAddressSpace()
1019 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
1022 * Create a vector type that contains a defined type and has a specific
1023 * number of elements.
1025 * The created type will exist in the context thats its element type
1028 * @see llvm::VectorType::get()
1030 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
1033 * Obtain the number of elements in a vector type.
1035 * This only works on types that represent vectors.
1037 * @see llvm::VectorType::getNumElements()
1039 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1046 * @defgroup LLVMCCoreTypeOther Other Types
1052 * Create a void type in a context.
1054 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1057 * Create a label type in a context.
1059 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1062 * Create a X86 MMX type in a context.
1064 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1067 * These are similar to the above functions except they operate on the
1070 LLVMTypeRef LLVMVoidType(void);
1071 LLVMTypeRef LLVMLabelType(void);
1072 LLVMTypeRef LLVMX86MMXType(void);
1083 * @defgroup LLVMCCoreValues Values
1085 * The bulk of LLVM's object model consists of values, which comprise a very
1086 * rich type hierarchy.
1088 * LLVMValueRef essentially represents llvm::Value. There is a rich
1089 * hierarchy of classes within this type. Depending on the instance
1090 * obtained, not all APIs are available.
1092 * Callers can determine the type of an LLVMValueRef by calling the
1093 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1094 * functions are defined by a macro, so it isn't obvious which are
1095 * available by looking at the Doxygen source code. Instead, look at the
1096 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1097 * of value names given. These value names also correspond to classes in
1098 * the llvm::Value hierarchy.
1103 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1111 macro(BlockAddress) \
1112 macro(ConstantAggregateZero) \
1113 macro(ConstantArray) \
1114 macro(ConstantDataSequential) \
1115 macro(ConstantDataArray) \
1116 macro(ConstantDataVector) \
1117 macro(ConstantExpr) \
1119 macro(ConstantInt) \
1120 macro(ConstantPointerNull) \
1121 macro(ConstantStruct) \
1122 macro(ConstantVector) \
1123 macro(GlobalValue) \
1125 macro(GlobalAlias) \
1126 macro(GlobalVariable) \
1128 macro(Instruction) \
1129 macro(BinaryOperator) \
1131 macro(IntrinsicInst) \
1132 macro(DbgInfoIntrinsic) \
1133 macro(DbgDeclareInst) \
1134 macro(MemIntrinsic) \
1136 macro(MemMoveInst) \
1141 macro(ExtractElementInst) \
1142 macro(GetElementPtrInst) \
1143 macro(InsertElementInst) \
1144 macro(InsertValueInst) \
1145 macro(LandingPadInst) \
1148 macro(ShuffleVectorInst) \
1150 macro(TerminatorInst) \
1152 macro(IndirectBrInst) \
1156 macro(UnreachableInst) \
1158 macro(UnaryInstruction) \
1161 macro(AddrSpaceCastInst) \
1162 macro(BitCastInst) \
1166 macro(FPTruncInst) \
1167 macro(IntToPtrInst) \
1168 macro(PtrToIntInst) \
1174 macro(ExtractValueInst) \
1179 * @defgroup LLVMCCoreValueGeneral General APIs
1181 * Functions in this section work on all LLVMValueRef instances,
1182 * regardless of their sub-type. They correspond to functions available
1189 * Obtain the type of a value.
1191 * @see llvm::Value::getType()
1193 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1196 * Obtain the string name of a value.
1198 * @see llvm::Value::getName()
1200 const char *LLVMGetValueName(LLVMValueRef Val);
1203 * Set the string name of a value.
1205 * @see llvm::Value::setName()
1207 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1210 * Dump a representation of a value to stderr.
1212 * @see llvm::Value::dump()
1214 void LLVMDumpValue(LLVMValueRef Val);
1217 * Return a string representation of the value. Use
1218 * LLVMDisposeMessage to free the string.
1220 * @see llvm::Value::print()
1222 char *LLVMPrintValueToString(LLVMValueRef Val);
1225 * Replace all uses of a value with another one.
1227 * @see llvm::Value::replaceAllUsesWith()
1229 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1232 * Determine whether the specified constant instance is constant.
1234 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1237 * Determine whether a value instance is undefined.
1239 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1242 * Convert value instances between types.
1244 * Internally, an LLVMValueRef is "pinned" to a specific type. This
1245 * series of functions allows you to cast an instance to a specific
1248 * If the cast is not valid for the specified type, NULL is returned.
1250 * @see llvm::dyn_cast_or_null<>
1252 #define LLVM_DECLARE_VALUE_CAST(name) \
1253 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1254 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1261 * @defgroup LLVMCCoreValueUses Usage
1263 * This module defines functions that allow you to inspect the uses of a
1266 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1267 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1268 * llvm::User and llvm::Value.
1274 * Obtain the first use of a value.
1276 * Uses are obtained in an iterator fashion. First, call this function
1277 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1278 * on that instance and all subsequently obtained instances until
1279 * LLVMGetNextUse() returns NULL.
1281 * @see llvm::Value::use_begin()
1283 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1286 * Obtain the next use of a value.
1288 * This effectively advances the iterator. It returns NULL if you are on
1289 * the final use and no more are available.
1291 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1294 * Obtain the user value for a user.
1296 * The returned value corresponds to a llvm::User type.
1298 * @see llvm::Use::getUser()
1300 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1303 * Obtain the value this use corresponds to.
1305 * @see llvm::Use::get().
1307 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1314 * @defgroup LLVMCCoreValueUser User value
1316 * Function in this group pertain to LLVMValueRef instances that descent
1317 * from llvm::User. This includes constants, instructions, and
1324 * Obtain an operand at a specific index in a llvm::User value.
1326 * @see llvm::User::getOperand()
1328 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1331 * Set an operand at a specific index in a llvm::User value.
1333 * @see llvm::User::setOperand()
1335 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1338 * Obtain the number of operands in a llvm::User value.
1340 * @see llvm::User::getNumOperands()
1342 int LLVMGetNumOperands(LLVMValueRef Val);
1349 * @defgroup LLVMCCoreValueConstant Constants
1351 * This section contains APIs for interacting with LLVMValueRef that
1352 * correspond to llvm::Constant instances.
1354 * These functions will work for any LLVMValueRef in the llvm::Constant
1361 * Obtain a constant value referring to the null instance of a type.
1363 * @see llvm::Constant::getNullValue()
1365 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1368 * Obtain a constant value referring to the instance of a type
1369 * consisting of all ones.
1371 * This is only valid for integer types.
1373 * @see llvm::Constant::getAllOnesValue()
1375 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1378 * Obtain a constant value referring to an undefined value of a type.
1380 * @see llvm::UndefValue::get()
1382 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1385 * Determine whether a value instance is null.
1387 * @see llvm::Constant::isNullValue()
1389 LLVMBool LLVMIsNull(LLVMValueRef Val);
1392 * Obtain a constant that is a constant pointer pointing to NULL for a
1395 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1398 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1400 * Functions in this group model LLVMValueRef instances that correspond
1401 * to constants referring to scalar types.
1403 * For integer types, the LLVMTypeRef parameter should correspond to a
1404 * llvm::IntegerType instance and the returned LLVMValueRef will
1405 * correspond to a llvm::ConstantInt.
1407 * For floating point types, the LLVMTypeRef returned corresponds to a
1414 * Obtain a constant value for an integer type.
1416 * The returned value corresponds to a llvm::ConstantInt.
1418 * @see llvm::ConstantInt::get()
1420 * @param IntTy Integer type to obtain value of.
1421 * @param N The value the returned instance should refer to.
1422 * @param SignExtend Whether to sign extend the produced value.
1424 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1425 LLVMBool SignExtend);
1428 * Obtain a constant value for an integer of arbitrary precision.
1430 * @see llvm::ConstantInt::get()
1432 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1434 const uint64_t Words[]);
1437 * Obtain a constant value for an integer parsed from a string.
1439 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1440 * string's length is available, it is preferred to call that function
1443 * @see llvm::ConstantInt::get()
1445 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1449 * Obtain a constant value for an integer parsed from a string with
1452 * @see llvm::ConstantInt::get()
1454 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1455 unsigned SLen, uint8_t Radix);
1458 * Obtain a constant value referring to a double floating point value.
1460 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1463 * Obtain a constant for a floating point value parsed from a string.
1465 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1466 * should be used if the input string's length is known.
1468 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1471 * Obtain a constant for a floating point value parsed from a string.
1473 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1477 * Obtain the zero extended value for an integer constant value.
1479 * @see llvm::ConstantInt::getZExtValue()
1481 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1484 * Obtain the sign extended value for an integer constant value.
1486 * @see llvm::ConstantInt::getSExtValue()
1488 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1495 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1497 * Functions in this group operate on composite constants.
1503 * Create a ConstantDataSequential and initialize it with a string.
1505 * @see llvm::ConstantDataArray::getString()
1507 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1508 unsigned Length, LLVMBool DontNullTerminate);
1511 * Create a ConstantDataSequential with string content in the global context.
1513 * This is the same as LLVMConstStringInContext except it operates on the
1516 * @see LLVMConstStringInContext()
1517 * @see llvm::ConstantDataArray::getString()
1519 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1520 LLVMBool DontNullTerminate);
1523 * Create an anonymous ConstantStruct with the specified values.
1525 * @see llvm::ConstantStruct::getAnon()
1527 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1528 LLVMValueRef *ConstantVals,
1529 unsigned Count, LLVMBool Packed);
1532 * Create a ConstantStruct in the global Context.
1534 * This is the same as LLVMConstStructInContext except it operates on the
1537 * @see LLVMConstStructInContext()
1539 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1543 * Create a ConstantArray from values.
1545 * @see llvm::ConstantArray::get()
1547 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1548 LLVMValueRef *ConstantVals, unsigned Length);
1551 * Create a non-anonymous ConstantStruct from values.
1553 * @see llvm::ConstantStruct::get()
1555 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1556 LLVMValueRef *ConstantVals,
1560 * Create a ConstantVector from values.
1562 * @see llvm::ConstantVector::get()
1564 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1571 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1573 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1575 * @see llvm::ConstantExpr.
1579 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1580 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1581 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1582 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1583 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1584 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1585 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1586 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1587 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1588 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1589 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1590 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1591 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1592 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1593 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1594 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1595 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1596 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1597 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1598 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1599 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1600 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1601 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1602 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1603 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1604 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1605 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1606 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1607 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1608 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1609 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1610 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1611 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1612 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1613 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1614 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1615 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1616 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1617 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1618 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1619 LLVMValueRef *ConstantIndices,
1620 unsigned NumIndices);
1621 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1622 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1623 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1624 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1625 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1626 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1627 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1628 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1629 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1630 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1631 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1632 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1633 LLVMValueRef LLVMConstAddrSpaceCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1634 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1635 LLVMTypeRef ToType);
1636 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1637 LLVMTypeRef ToType);
1638 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1639 LLVMTypeRef ToType);
1640 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1641 LLVMTypeRef ToType);
1642 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1644 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1645 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1646 LLVMValueRef ConstantIfTrue,
1647 LLVMValueRef ConstantIfFalse);
1648 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1649 LLVMValueRef IndexConstant);
1650 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1651 LLVMValueRef ElementValueConstant,
1652 LLVMValueRef IndexConstant);
1653 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1654 LLVMValueRef VectorBConstant,
1655 LLVMValueRef MaskConstant);
1656 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1658 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1659 LLVMValueRef ElementValueConstant,
1660 unsigned *IdxList, unsigned NumIdx);
1661 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1662 const char *AsmString, const char *Constraints,
1663 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1664 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1671 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1673 * This group contains functions that operate on global values. Functions in
1674 * this group relate to functions in the llvm::GlobalValue class tree.
1676 * @see llvm::GlobalValue
1681 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1682 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1683 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1684 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1685 const char *LLVMGetSection(LLVMValueRef Global);
1686 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1687 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1688 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1689 LLVMDLLStorageClass LLVMGetDLLStorageClass(LLVMValueRef Global);
1690 void LLVMSetDLLStorageClass(LLVMValueRef Global, LLVMDLLStorageClass Class);
1691 LLVMBool LLVMHasUnnamedAddr(LLVMValueRef Global);
1692 void LLVMSetUnnamedAddr(LLVMValueRef Global, LLVMBool HasUnnamedAddr);
1695 * @defgroup LLVMCCoreValueWithAlignment Values with alignment
1697 * Functions in this group only apply to values with alignment, i.e.
1698 * global variables, load and store instructions.
1702 * Obtain the preferred alignment of the value.
1703 * @see llvm::AllocaInst::getAlignment()
1704 * @see llvm::LoadInst::getAlignment()
1705 * @see llvm::StoreInst::getAlignment()
1706 * @see llvm::GlobalValue::getAlignment()
1708 unsigned LLVMGetAlignment(LLVMValueRef V);
1711 * Set the preferred alignment of the value.
1712 * @see llvm::AllocaInst::setAlignment()
1713 * @see llvm::LoadInst::setAlignment()
1714 * @see llvm::StoreInst::setAlignment()
1715 * @see llvm::GlobalValue::setAlignment()
1717 void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes);
1724 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1726 * This group contains functions that operate on global variable values.
1728 * @see llvm::GlobalVariable
1732 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1733 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1735 unsigned AddressSpace);
1736 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1737 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1738 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1739 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1740 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1741 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1742 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1743 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1744 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1745 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1746 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1747 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1748 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1749 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1750 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1751 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1758 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1760 * This group contains function that operate on global alias values.
1762 * @see llvm::GlobalAlias
1766 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1774 * @defgroup LLVMCCoreValueFunction Function values
1776 * Functions in this group operate on LLVMValueRef instances that
1777 * correspond to llvm::Function instances.
1779 * @see llvm::Function
1785 * Remove a function from its containing module and deletes it.
1787 * @see llvm::Function::eraseFromParent()
1789 void LLVMDeleteFunction(LLVMValueRef Fn);
1792 * Obtain the ID number from a function instance.
1794 * @see llvm::Function::getIntrinsicID()
1796 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1799 * Obtain the calling function of a function.
1801 * The returned value corresponds to the LLVMCallConv enumeration.
1803 * @see llvm::Function::getCallingConv()
1805 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1808 * Set the calling convention of a function.
1810 * @see llvm::Function::setCallingConv()
1812 * @param Fn Function to operate on
1813 * @param CC LLVMCallConv to set calling convention to
1815 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1818 * Obtain the name of the garbage collector to use during code
1821 * @see llvm::Function::getGC()
1823 const char *LLVMGetGC(LLVMValueRef Fn);
1826 * Define the garbage collector to use during code generation.
1828 * @see llvm::Function::setGC()
1830 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1833 * Add an attribute to a function.
1835 * @see llvm::Function::addAttribute()
1837 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1840 * Add a target-dependent attribute to a fuction
1841 * @see llvm::AttrBuilder::addAttribute()
1843 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1847 * Obtain an attribute from a function.
1849 * @see llvm::Function::getAttributes()
1851 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1854 * Remove an attribute from a function.
1856 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1859 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1861 * Functions in this group relate to arguments/parameters on functions.
1863 * Functions in this group expect LLVMValueRef instances that correspond
1864 * to llvm::Function instances.
1870 * Obtain the number of parameters in a function.
1872 * @see llvm::Function::arg_size()
1874 unsigned LLVMCountParams(LLVMValueRef Fn);
1877 * Obtain the parameters in a function.
1879 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1880 * at least LLVMCountParams() long. This array will be filled with
1881 * LLVMValueRef instances which correspond to the parameters the
1882 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1885 * @see llvm::Function::arg_begin()
1887 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1890 * Obtain the parameter at the specified index.
1892 * Parameters are indexed from 0.
1894 * @see llvm::Function::arg_begin()
1896 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1899 * Obtain the function to which this argument belongs.
1901 * Unlike other functions in this group, this one takes an LLVMValueRef
1902 * that corresponds to a llvm::Attribute.
1904 * The returned LLVMValueRef is the llvm::Function to which this
1907 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1910 * Obtain the first parameter to a function.
1912 * @see llvm::Function::arg_begin()
1914 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1917 * Obtain the last parameter to a function.
1919 * @see llvm::Function::arg_end()
1921 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
1924 * Obtain the next parameter to a function.
1926 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
1927 * actually a wrapped iterator) and obtains the next parameter from the
1928 * underlying iterator.
1930 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
1933 * Obtain the previous parameter to a function.
1935 * This is the opposite of LLVMGetNextParam().
1937 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
1940 * Add an attribute to a function argument.
1942 * @see llvm::Argument::addAttr()
1944 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1947 * Remove an attribute from a function argument.
1949 * @see llvm::Argument::removeAttr()
1951 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1954 * Get an attribute from a function argument.
1956 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
1959 * Set the alignment for a function parameter.
1961 * @see llvm::Argument::addAttr()
1962 * @see llvm::AttrBuilder::addAlignmentAttr()
1964 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
1983 * @defgroup LLVMCCoreValueMetadata Metadata
1989 * Obtain a MDString value from a context.
1991 * The returned instance corresponds to the llvm::MDString class.
1993 * The instance is specified by string data of a specified length. The
1994 * string content is copied, so the backing memory can be freed after
1995 * this function returns.
1997 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
2001 * Obtain a MDString value from the global context.
2003 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
2006 * Obtain a MDNode value from a context.
2008 * The returned value corresponds to the llvm::MDNode class.
2010 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
2014 * Obtain a MDNode value from the global context.
2016 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
2019 * Obtain the underlying string from a MDString value.
2021 * @param V Instance to obtain string from.
2022 * @param Len Memory address which will hold length of returned string.
2023 * @return String data in MDString.
2025 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
2028 * Obtain the number of operands from an MDNode value.
2030 * @param V MDNode to get number of operands from.
2031 * @return Number of operands of the MDNode.
2033 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
2036 * Obtain the given MDNode's operands.
2038 * The passed LLVMValueRef pointer should point to enough memory to hold all of
2039 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
2040 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
2041 * MDNode's operands.
2043 * @param V MDNode to get the operands from.
2044 * @param Dest Destination array for operands.
2046 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
2053 * @defgroup LLVMCCoreValueBasicBlock Basic Block
2055 * A basic block represents a single entry single exit section of code.
2056 * Basic blocks contain a list of instructions which form the body of
2059 * Basic blocks belong to functions. They have the type of label.
2061 * Basic blocks are themselves values. However, the C API models them as
2062 * LLVMBasicBlockRef.
2064 * @see llvm::BasicBlock
2070 * Convert a basic block instance to a value type.
2072 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
2075 * Determine whether an LLVMValueRef is itself a basic block.
2077 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
2080 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
2082 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
2085 * Obtain the function to which a basic block belongs.
2087 * @see llvm::BasicBlock::getParent()
2089 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2092 * Obtain the terminator instruction for a basic block.
2094 * If the basic block does not have a terminator (it is not well-formed
2095 * if it doesn't), then NULL is returned.
2097 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2099 * @see llvm::BasicBlock::getTerminator()
2101 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2104 * Obtain the number of basic blocks in a function.
2106 * @param Fn Function value to operate on.
2108 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2111 * Obtain all of the basic blocks in a function.
2113 * This operates on a function value. The BasicBlocks parameter is a
2114 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2115 * LLVMCountBasicBlocks() in length. This array is populated with
2116 * LLVMBasicBlockRef instances.
2118 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2121 * Obtain the first basic block in a function.
2123 * The returned basic block can be used as an iterator. You will likely
2124 * eventually call into LLVMGetNextBasicBlock() with it.
2126 * @see llvm::Function::begin()
2128 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2131 * Obtain the last basic block in a function.
2133 * @see llvm::Function::end()
2135 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2138 * Advance a basic block iterator.
2140 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2143 * Go backwards in a basic block iterator.
2145 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2148 * Obtain the basic block that corresponds to the entry point of a
2151 * @see llvm::Function::getEntryBlock()
2153 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2156 * Append a basic block to the end of a function.
2158 * @see llvm::BasicBlock::Create()
2160 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2165 * Append a basic block to the end of a function using the global
2168 * @see llvm::BasicBlock::Create()
2170 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2173 * Insert a basic block in a function before another basic block.
2175 * The function to add to is determined by the function of the
2176 * passed basic block.
2178 * @see llvm::BasicBlock::Create()
2180 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2181 LLVMBasicBlockRef BB,
2185 * Insert a basic block in a function using the global context.
2187 * @see llvm::BasicBlock::Create()
2189 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2193 * Remove a basic block from a function and delete it.
2195 * This deletes the basic block from its containing function and deletes
2196 * the basic block itself.
2198 * @see llvm::BasicBlock::eraseFromParent()
2200 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2203 * Remove a basic block from a function.
2205 * This deletes the basic block from its containing function but keep
2206 * the basic block alive.
2208 * @see llvm::BasicBlock::removeFromParent()
2210 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2213 * Move a basic block to before another one.
2215 * @see llvm::BasicBlock::moveBefore()
2217 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2220 * Move a basic block to after another one.
2222 * @see llvm::BasicBlock::moveAfter()
2224 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2227 * Obtain the first instruction in a basic block.
2229 * The returned LLVMValueRef corresponds to a llvm::Instruction
2232 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2235 * Obtain the last instruction in a basic block.
2237 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2239 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2246 * @defgroup LLVMCCoreValueInstruction Instructions
2248 * Functions in this group relate to the inspection and manipulation of
2249 * individual instructions.
2251 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2252 * class has a large number of descendents. llvm::Instruction is a
2253 * llvm::Value and in the C API, instructions are modeled by
2256 * This group also contains sub-groups which operate on specific
2257 * llvm::Instruction types, e.g. llvm::CallInst.
2263 * Determine whether an instruction has any metadata attached.
2265 int LLVMHasMetadata(LLVMValueRef Val);
2268 * Return metadata associated with an instruction value.
2270 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2273 * Set metadata associated with an instruction value.
2275 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2278 * Obtain the basic block to which an instruction belongs.
2280 * @see llvm::Instruction::getParent()
2282 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2285 * Obtain the instruction that occurs after the one specified.
2287 * The next instruction will be from the same basic block.
2289 * If this is the last instruction in a basic block, NULL will be
2292 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2295 * Obtain the instruction that occurred before this one.
2297 * If the instruction is the first instruction in a basic block, NULL
2300 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2303 * Remove and delete an instruction.
2305 * The instruction specified is removed from its containing building
2306 * block and then deleted.
2308 * @see llvm::Instruction::eraseFromParent()
2310 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2313 * Obtain the code opcode for an individual instruction.
2315 * @see llvm::Instruction::getOpCode()
2317 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2320 * Obtain the predicate of an instruction.
2322 * This is only valid for instructions that correspond to llvm::ICmpInst
2323 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2325 * @see llvm::ICmpInst::getPredicate()
2327 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2330 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2332 * Functions in this group apply to instructions that refer to call
2333 * sites and invocations. These correspond to C++ types in the
2334 * llvm::CallInst class tree.
2340 * Set the calling convention for a call instruction.
2342 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2345 * @see llvm::CallInst::setCallingConv()
2346 * @see llvm::InvokeInst::setCallingConv()
2348 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2351 * Obtain the calling convention for a call instruction.
2353 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2356 * @see LLVMSetInstructionCallConv()
2358 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2361 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2362 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2364 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2368 * Obtain whether a call instruction is a tail call.
2370 * This only works on llvm::CallInst instructions.
2372 * @see llvm::CallInst::isTailCall()
2374 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2377 * Set whether a call instruction is a tail call.
2379 * This only works on llvm::CallInst instructions.
2381 * @see llvm::CallInst::setTailCall()
2383 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2390 * Obtain the default destination basic block of a switch instruction.
2392 * This only works on llvm::SwitchInst instructions.
2394 * @see llvm::SwitchInst::getDefaultDest()
2396 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2399 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2401 * Functions in this group only apply to instructions that map to
2402 * llvm::PHINode instances.
2408 * Add an incoming value to the end of a PHI list.
2410 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2411 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2414 * Obtain the number of incoming basic blocks to a PHI node.
2416 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2419 * Obtain an incoming value to a PHI node as an LLVMValueRef.
2421 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2424 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2426 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2441 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2443 * An instruction builder represents a point within a basic block and is
2444 * the exclusive means of building instructions using the C interface.
2449 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2450 LLVMBuilderRef LLVMCreateBuilder(void);
2451 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2452 LLVMValueRef Instr);
2453 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2454 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2455 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2456 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2457 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2458 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2460 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2463 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2464 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2465 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2468 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2469 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2470 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2472 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2473 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2474 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2475 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2476 LLVMBasicBlockRef Else, unsigned NumCases);
2477 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2479 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2480 LLVMValueRef *Args, unsigned NumArgs,
2481 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2483 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2484 LLVMValueRef PersFn, unsigned NumClauses,
2486 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2487 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2489 /* Add a case to the switch instruction */
2490 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2491 LLVMBasicBlockRef Dest);
2493 /* Add a destination to the indirectbr instruction */
2494 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2496 /* Add a catch or filter clause to the landingpad instruction */
2497 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2499 /* Set the 'cleanup' flag in the landingpad instruction */
2500 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2503 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2505 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2507 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2509 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2511 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2513 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2515 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2517 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2519 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2521 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2523 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2525 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2527 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2529 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2531 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2533 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2535 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2537 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2539 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2541 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2543 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2545 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2547 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2549 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2551 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2553 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2554 LLVMValueRef LHS, LLVMValueRef RHS,
2556 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2557 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2559 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2561 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2562 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2565 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2566 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2567 LLVMValueRef Val, const char *Name);
2568 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2569 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2570 LLVMValueRef Val, const char *Name);
2571 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2572 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2574 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2575 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2576 LLVMValueRef *Indices, unsigned NumIndices,
2578 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2579 LLVMValueRef *Indices, unsigned NumIndices,
2581 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2582 unsigned Idx, const char *Name);
2583 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2585 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2587 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2588 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2591 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2592 LLVMTypeRef DestTy, const char *Name);
2593 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2594 LLVMTypeRef DestTy, const char *Name);
2595 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2596 LLVMTypeRef DestTy, const char *Name);
2597 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2598 LLVMTypeRef DestTy, const char *Name);
2599 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2600 LLVMTypeRef DestTy, const char *Name);
2601 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2602 LLVMTypeRef DestTy, const char *Name);
2603 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2604 LLVMTypeRef DestTy, const char *Name);
2605 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2606 LLVMTypeRef DestTy, const char *Name);
2607 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2608 LLVMTypeRef DestTy, const char *Name);
2609 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2610 LLVMTypeRef DestTy, const char *Name);
2611 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2612 LLVMTypeRef DestTy, const char *Name);
2613 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2614 LLVMTypeRef DestTy, const char *Name);
2615 LLVMValueRef LLVMBuildAddrSpaceCast(LLVMBuilderRef, LLVMValueRef Val,
2616 LLVMTypeRef DestTy, const char *Name);
2617 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2618 LLVMTypeRef DestTy, const char *Name);
2619 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2620 LLVMTypeRef DestTy, const char *Name);
2621 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2622 LLVMTypeRef DestTy, const char *Name);
2623 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2624 LLVMTypeRef DestTy, const char *Name);
2625 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2626 LLVMTypeRef DestTy, const char *Name);
2627 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2628 LLVMTypeRef DestTy, const char *Name);
2629 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2630 LLVMTypeRef DestTy, const char *Name);
2633 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2634 LLVMValueRef LHS, LLVMValueRef RHS,
2636 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2637 LLVMValueRef LHS, LLVMValueRef RHS,
2640 /* Miscellaneous instructions */
2641 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2642 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2643 LLVMValueRef *Args, unsigned NumArgs,
2645 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2646 LLVMValueRef Then, LLVMValueRef Else,
2648 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2650 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2651 LLVMValueRef Index, const char *Name);
2652 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2653 LLVMValueRef EltVal, LLVMValueRef Index,
2655 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2656 LLVMValueRef V2, LLVMValueRef Mask,
2658 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2659 unsigned Index, const char *Name);
2660 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2661 LLVMValueRef EltVal, unsigned Index,
2664 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2666 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2668 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2669 LLVMValueRef RHS, const char *Name);
2670 LLVMValueRef LLVMBuildFence(LLVMBuilderRef B, LLVMAtomicOrdering ordering,
2671 LLVMBool singleThread, const char *Name);
2672 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B, LLVMAtomicRMWBinOp op,
2673 LLVMValueRef PTR, LLVMValueRef Val,
2674 LLVMAtomicOrdering ordering,
2675 LLVMBool singleThread);
2682 * @defgroup LLVMCCoreModuleProvider Module Providers
2688 * Changes the type of M so it can be passed to FunctionPassManagers and the
2689 * JIT. They take ModuleProviders for historical reasons.
2691 LLVMModuleProviderRef
2692 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2695 * Destroys the module M.
2697 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2704 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2709 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2710 LLVMMemoryBufferRef *OutMemBuf,
2712 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2714 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2715 size_t InputDataLength,
2716 const char *BufferName,
2717 LLVMBool RequiresNullTerminator);
2718 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2719 size_t InputDataLength,
2720 const char *BufferName);
2721 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2722 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2723 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2730 * @defgroup LLVMCCorePassRegistry Pass Registry
2735 /** Return the global pass registry, for use with initialization functions.
2736 @see llvm::PassRegistry::getPassRegistry */
2737 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2744 * @defgroup LLVMCCorePassManagers Pass Managers
2749 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2750 suitable for link-time optimization and whole-module transformations.
2751 @see llvm::PassManager::PassManager */
2752 LLVMPassManagerRef LLVMCreatePassManager(void);
2754 /** Constructs a new function-by-function pass pipeline over the module
2755 provider. It does not take ownership of the module provider. This type of
2756 pipeline is suitable for code generation and JIT compilation tasks.
2757 @see llvm::FunctionPassManager::FunctionPassManager */
2758 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2760 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2761 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2763 /** Initializes, executes on the provided module, and finalizes all of the
2764 passes scheduled in the pass manager. Returns 1 if any of the passes
2765 modified the module, 0 otherwise.
2766 @see llvm::PassManager::run(Module&) */
2767 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2769 /** Initializes all of the function passes scheduled in the function pass
2770 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2771 @see llvm::FunctionPassManager::doInitialization */
2772 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2774 /** Executes all of the function passes scheduled in the function pass manager
2775 on the provided function. Returns 1 if any of the passes modified the
2776 function, false otherwise.
2777 @see llvm::FunctionPassManager::run(Function&) */
2778 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2780 /** Finalizes all of the function passes scheduled in in the function pass
2781 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2782 @see llvm::FunctionPassManager::doFinalization */
2783 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2785 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2786 the module provider.
2787 @see llvm::PassManagerBase::~PassManagerBase. */
2788 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2795 * @defgroup LLVMCCoreThreading Threading
2797 * Handle the structures needed to make LLVM safe for multithreading.
2802 /** Allocate and initialize structures needed to make LLVM safe for
2803 multithreading. The return value indicates whether multithreaded
2804 initialization succeeded. Must be executed in isolation from all
2805 other LLVM api calls.
2806 @see llvm::llvm_start_multithreaded */
2807 LLVMBool LLVMStartMultithreaded(void);
2809 /** Deallocate structures necessary to make LLVM safe for multithreading.
2810 Must be executed in isolation from all other LLVM api calls.
2811 @see llvm::llvm_stop_multithreaded */
2812 void LLVMStopMultithreaded(void);
2814 /** Check whether LLVM is executing in thread-safe mode or not.
2815 @see llvm::llvm_is_multithreaded */
2816 LLVMBool LLVMIsMultithreaded(void);
2832 #endif /* !defined(__cplusplus) */
2834 #endif /* !defined(LLVM_C_CORE_H) */