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;
129 * @see llvm::DiagnosticInfo
131 typedef struct LLVMOpaqueDiagnosticInfo *LLVMDiagnosticInfoRef;
134 LLVMZExtAttribute = 1<<0,
135 LLVMSExtAttribute = 1<<1,
136 LLVMNoReturnAttribute = 1<<2,
137 LLVMInRegAttribute = 1<<3,
138 LLVMStructRetAttribute = 1<<4,
139 LLVMNoUnwindAttribute = 1<<5,
140 LLVMNoAliasAttribute = 1<<6,
141 LLVMByValAttribute = 1<<7,
142 LLVMNestAttribute = 1<<8,
143 LLVMReadNoneAttribute = 1<<9,
144 LLVMReadOnlyAttribute = 1<<10,
145 LLVMNoInlineAttribute = 1<<11,
146 LLVMAlwaysInlineAttribute = 1<<12,
147 LLVMOptimizeForSizeAttribute = 1<<13,
148 LLVMStackProtectAttribute = 1<<14,
149 LLVMStackProtectReqAttribute = 1<<15,
150 LLVMAlignment = 31<<16,
151 LLVMNoCaptureAttribute = 1<<21,
152 LLVMNoRedZoneAttribute = 1<<22,
153 LLVMNoImplicitFloatAttribute = 1<<23,
154 LLVMNakedAttribute = 1<<24,
155 LLVMInlineHintAttribute = 1<<25,
156 LLVMStackAlignment = 7<<26,
157 LLVMReturnsTwice = 1 << 29,
158 LLVMUWTable = 1 << 30,
159 LLVMNonLazyBind = 1 << 31
161 /* FIXME: These attributes are currently not included in the C API as
162 a temporary measure until the API/ABI impact to the C API is understood
163 and the path forward agreed upon.
164 LLVMAddressSafety = 1ULL << 32,
165 LLVMStackProtectStrongAttribute = 1ULL<<33,
166 LLVMCold = 1ULL << 34,
167 LLVMOptimizeNone = 1ULL << 35,
168 LLVMInAllocaAttribute = 1ULL << 36,
169 LLVMNonNullAttribute = 1ULL << 37,
170 LLVMJumpTableAttribute = 1ULL << 38,
171 LLVMDereferenceableAttribute = 1ULL << 39,
176 /* Terminator Instructions */
182 /* removed 6 due to API changes */
185 /* Standard Binary Operators */
199 /* Logical Operators */
207 /* Memory Operators */
211 LLVMGetElementPtr = 29,
226 LLVMAddrSpaceCast = 60,
228 /* Other Operators */
237 LLVMExtractElement = 50,
238 LLVMInsertElement = 51,
239 LLVMShuffleVector = 52,
240 LLVMExtractValue = 53,
241 LLVMInsertValue = 54,
243 /* Atomic operators */
245 LLVMAtomicCmpXchg = 56,
248 /* Exception Handling Operators */
255 LLVMVoidTypeKind, /**< type with no size */
256 LLVMHalfTypeKind, /**< 16 bit floating point type */
257 LLVMFloatTypeKind, /**< 32 bit floating point type */
258 LLVMDoubleTypeKind, /**< 64 bit floating point type */
259 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
260 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
261 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
262 LLVMLabelTypeKind, /**< Labels */
263 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
264 LLVMFunctionTypeKind, /**< Functions */
265 LLVMStructTypeKind, /**< Structures */
266 LLVMArrayTypeKind, /**< Arrays */
267 LLVMPointerTypeKind, /**< Pointers */
268 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
269 LLVMMetadataTypeKind, /**< Metadata */
270 LLVMX86_MMXTypeKind /**< X86 MMX */
274 LLVMExternalLinkage, /**< Externally visible function */
275 LLVMAvailableExternallyLinkage,
276 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
277 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
279 LLVMLinkOnceODRAutoHideLinkage, /**< Obsolete */
280 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
281 LLVMWeakODRLinkage, /**< Same, but only replaced by something
283 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
284 LLVMInternalLinkage, /**< Rename collisions when linking (static
286 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
287 LLVMDLLImportLinkage, /**< Obsolete */
288 LLVMDLLExportLinkage, /**< Obsolete */
289 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
290 LLVMGhostLinkage, /**< Obsolete */
291 LLVMCommonLinkage, /**< Tentative definitions */
292 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
293 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
297 LLVMDefaultVisibility, /**< The GV is visible */
298 LLVMHiddenVisibility, /**< The GV is hidden */
299 LLVMProtectedVisibility /**< The GV is protected */
303 LLVMDefaultStorageClass = 0,
304 LLVMDLLImportStorageClass = 1, /**< Function to be imported from DLL. */
305 LLVMDLLExportStorageClass = 2 /**< Function to be accessible from DLL. */
306 } LLVMDLLStorageClass;
310 LLVMFastCallConv = 8,
311 LLVMColdCallConv = 9,
312 LLVMWebKitJSCallConv = 12,
313 LLVMAnyRegCallConv = 13,
314 LLVMX86StdcallCallConv = 64,
315 LLVMX86FastcallCallConv = 65
319 LLVMIntEQ = 32, /**< equal */
320 LLVMIntNE, /**< not equal */
321 LLVMIntUGT, /**< unsigned greater than */
322 LLVMIntUGE, /**< unsigned greater or equal */
323 LLVMIntULT, /**< unsigned less than */
324 LLVMIntULE, /**< unsigned less or equal */
325 LLVMIntSGT, /**< signed greater than */
326 LLVMIntSGE, /**< signed greater or equal */
327 LLVMIntSLT, /**< signed less than */
328 LLVMIntSLE /**< signed less or equal */
332 LLVMRealPredicateFalse, /**< Always false (always folded) */
333 LLVMRealOEQ, /**< True if ordered and equal */
334 LLVMRealOGT, /**< True if ordered and greater than */
335 LLVMRealOGE, /**< True if ordered and greater than or equal */
336 LLVMRealOLT, /**< True if ordered and less than */
337 LLVMRealOLE, /**< True if ordered and less than or equal */
338 LLVMRealONE, /**< True if ordered and operands are unequal */
339 LLVMRealORD, /**< True if ordered (no nans) */
340 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
341 LLVMRealUEQ, /**< True if unordered or equal */
342 LLVMRealUGT, /**< True if unordered or greater than */
343 LLVMRealUGE, /**< True if unordered, greater than, or equal */
344 LLVMRealULT, /**< True if unordered or less than */
345 LLVMRealULE, /**< True if unordered, less than, or equal */
346 LLVMRealUNE, /**< True if unordered or not equal */
347 LLVMRealPredicateTrue /**< Always true (always folded) */
351 LLVMLandingPadCatch, /**< A catch clause */
352 LLVMLandingPadFilter /**< A filter clause */
353 } LLVMLandingPadClauseTy;
356 LLVMNotThreadLocal = 0,
357 LLVMGeneralDynamicTLSModel,
358 LLVMLocalDynamicTLSModel,
359 LLVMInitialExecTLSModel,
360 LLVMLocalExecTLSModel
361 } LLVMThreadLocalMode;
364 LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */
365 LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees
366 somewhat sane results, lock free. */
367 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the
368 operations affecting a specific address,
369 a consistent ordering exists */
370 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort
371 necessary to acquire a lock to access other
372 memory with normal loads and stores. */
373 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with
374 a barrier of the sort necessary to release
376 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
377 Release barrier (for fences and
378 operations which both read and write
380 LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics
381 for loads and Release
382 semantics for stores.
383 Additionally, it guarantees
384 that a total ordering exists
386 SequentiallyConsistent
388 } LLVMAtomicOrdering;
391 LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */
392 LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */
393 LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */
394 LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */
395 LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */
396 LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */
397 LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */
398 LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the
399 original using a signed comparison and return
401 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
402 original using a signed comparison and return
404 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
405 original using an unsigned comparison and return
407 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
408 original using an unsigned comparison and return
410 } LLVMAtomicRMWBinOp;
417 } LLVMDiagnosticSeverity;
423 void LLVMInitializeCore(LLVMPassRegistryRef R);
425 /** Deallocate and destroy all ManagedStatic variables.
426 @see llvm::llvm_shutdown
427 @see ManagedStatic */
428 void LLVMShutdown(void);
431 /*===-- Error handling ----------------------------------------------------===*/
433 char *LLVMCreateMessage(const char *Message);
434 void LLVMDisposeMessage(char *Message);
436 typedef void (*LLVMFatalErrorHandler)(const char *Reason);
439 * Install a fatal error handler. By default, if LLVM detects a fatal error, it
440 * will call exit(1). This may not be appropriate in many contexts. For example,
441 * doing exit(1) will bypass many crash reporting/tracing system tools. This
442 * function allows you to install a callback that will be invoked prior to the
445 void LLVMInstallFatalErrorHandler(LLVMFatalErrorHandler Handler);
448 * Reset the fatal error handler. This resets LLVM's fatal error handling
449 * behavior to the default.
451 void LLVMResetFatalErrorHandler(void);
454 * Enable LLVM's built-in stack trace code. This intercepts the OS's crash
455 * signals and prints which component of LLVM you were in at the time if the
458 void LLVMEnablePrettyStackTrace(void);
461 * @defgroup LLVMCCoreContext Contexts
463 * Contexts are execution states for the core LLVM IR system.
465 * Most types are tied to a context instance. Multiple contexts can
466 * exist simultaneously. A single context is not thread safe. However,
467 * different contexts can execute on different threads simultaneously.
472 typedef void (*LLVMDiagnosticHandler)(LLVMDiagnosticInfoRef, void *);
473 typedef void (*LLVMYieldCallback)(LLVMContextRef, void *);
476 * Create a new context.
478 * Every call to this function should be paired with a call to
479 * LLVMContextDispose() or the context will leak memory.
481 LLVMContextRef LLVMContextCreate(void);
484 * Obtain the global context instance.
486 LLVMContextRef LLVMGetGlobalContext(void);
489 * Set the diagnostic handler for this context.
491 void LLVMContextSetDiagnosticHandler(LLVMContextRef C,
492 LLVMDiagnosticHandler Handler,
493 void *DiagnosticContext);
496 * Set the yield callback function for this context.
498 * @see LLVMContext::setYieldCallback()
500 void LLVMContextSetYieldCallback(LLVMContextRef C, LLVMYieldCallback Callback,
504 * Destroy a context instance.
506 * This should be called for every call to LLVMContextCreate() or memory
509 void LLVMContextDispose(LLVMContextRef C);
512 * Return a string representation of the DiagnosticInfo. Use
513 * LLVMDisposeMessage to free the string.
515 * @see DiagnosticInfo::print()
517 char *LLVMGetDiagInfoDescription(LLVMDiagnosticInfoRef DI);
520 * Return an enum LLVMDiagnosticSeverity.
522 * @see DiagnosticInfo::getSeverity()
524 LLVMDiagnosticSeverity LLVMGetDiagInfoSeverity(LLVMDiagnosticInfoRef DI);
526 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
528 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
535 * @defgroup LLVMCCoreModule Modules
537 * Modules represent the top-level structure in an LLVM program. An LLVM
538 * module is effectively a translation unit or a collection of
539 * translation units merged together.
545 * Create a new, empty module in the global context.
547 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
548 * LLVMGetGlobalContext() as the context parameter.
550 * Every invocation should be paired with LLVMDisposeModule() or memory
553 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
556 * Create a new, empty module in a specific context.
558 * Every invocation should be paired with LLVMDisposeModule() or memory
561 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
565 * Destroy a module instance.
567 * This must be called for every created module or memory will be
570 void LLVMDisposeModule(LLVMModuleRef M);
573 * Obtain the data layout for a module.
575 * @see Module::getDataLayout()
577 const char *LLVMGetDataLayout(LLVMModuleRef M);
580 * Set the data layout for a module.
582 * @see Module::setDataLayout()
584 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
587 * Obtain the target triple for a module.
589 * @see Module::getTargetTriple()
591 const char *LLVMGetTarget(LLVMModuleRef M);
594 * Set the target triple for a module.
596 * @see Module::setTargetTriple()
598 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
601 * Dump a representation of a module to stderr.
603 * @see Module::dump()
605 void LLVMDumpModule(LLVMModuleRef M);
608 * Print a representation of a module to a file. The ErrorMessage needs to be
609 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
611 * @see Module::print()
613 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
614 char **ErrorMessage);
617 * Return a string representation of the module. Use
618 * LLVMDisposeMessage to free the string.
620 * @see Module::print()
622 char *LLVMPrintModuleToString(LLVMModuleRef M);
625 * Set inline assembly for a module.
627 * @see Module::setModuleInlineAsm()
629 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
632 * Obtain the context to which this module is associated.
634 * @see Module::getContext()
636 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
639 * Obtain a Type from a module by its registered name.
641 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
644 * Obtain the number of operands for named metadata in a module.
646 * @see llvm::Module::getNamedMetadata()
648 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
651 * Obtain the named metadata operands for a module.
653 * The passed LLVMValueRef pointer should refer to an array of
654 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
655 * array will be populated with the LLVMValueRef instances. Each
656 * instance corresponds to a llvm::MDNode.
658 * @see llvm::Module::getNamedMetadata()
659 * @see llvm::MDNode::getOperand()
661 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
664 * Add an operand to named metadata.
666 * @see llvm::Module::getNamedMetadata()
667 * @see llvm::MDNode::addOperand()
669 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
673 * Add a function to a module under a specified name.
675 * @see llvm::Function::Create()
677 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
678 LLVMTypeRef FunctionTy);
681 * Obtain a Function value from a Module by its name.
683 * The returned value corresponds to a llvm::Function value.
685 * @see llvm::Module::getFunction()
687 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
690 * Obtain an iterator to the first Function in a Module.
692 * @see llvm::Module::begin()
694 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
697 * Obtain an iterator to the last Function in a Module.
699 * @see llvm::Module::end()
701 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
704 * Advance a Function iterator to the next Function.
706 * Returns NULL if the iterator was already at the end and there are no more
709 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
712 * Decrement a Function iterator to the previous Function.
714 * Returns NULL if the iterator was already at the beginning and there are
715 * no previous functions.
717 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
724 * @defgroup LLVMCCoreType Types
726 * Types represent the type of a value.
728 * Types are associated with a context instance. The context internally
729 * deduplicates types so there is only 1 instance of a specific type
730 * alive at a time. In other words, a unique type is shared among all
731 * consumers within a context.
733 * A Type in the C API corresponds to llvm::Type.
735 * Types have the following hierarchy:
753 * Obtain the enumerated type of a Type instance.
755 * @see llvm::Type:getTypeID()
757 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
760 * Whether the type has a known size.
762 * Things that don't have a size are abstract types, labels, and void.a
764 * @see llvm::Type::isSized()
766 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
769 * Obtain the context to which this type instance is associated.
771 * @see llvm::Type::getContext()
773 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
776 * Dump a representation of a type to stderr.
778 * @see llvm::Type::dump()
780 void LLVMDumpType(LLVMTypeRef Val);
783 * Return a string representation of the type. Use
784 * LLVMDisposeMessage to free the string.
786 * @see llvm::Type::print()
788 char *LLVMPrintTypeToString(LLVMTypeRef Val);
791 * @defgroup LLVMCCoreTypeInt Integer Types
793 * Functions in this section operate on integer types.
799 * Obtain an integer type from a context with specified bit width.
801 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
802 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
803 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
804 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
805 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
806 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
809 * Obtain an integer type from the global context with a specified bit
812 LLVMTypeRef LLVMInt1Type(void);
813 LLVMTypeRef LLVMInt8Type(void);
814 LLVMTypeRef LLVMInt16Type(void);
815 LLVMTypeRef LLVMInt32Type(void);
816 LLVMTypeRef LLVMInt64Type(void);
817 LLVMTypeRef LLVMIntType(unsigned NumBits);
818 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
825 * @defgroup LLVMCCoreTypeFloat Floating Point Types
831 * Obtain a 16-bit floating point type from a context.
833 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
836 * Obtain a 32-bit floating point type from a context.
838 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
841 * Obtain a 64-bit floating point type from a context.
843 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
846 * Obtain a 80-bit floating point type (X87) from a context.
848 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
851 * Obtain a 128-bit floating point type (112-bit mantissa) from a
854 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
857 * Obtain a 128-bit floating point type (two 64-bits) from a context.
859 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
862 * Obtain a floating point type from the global context.
864 * These map to the functions in this group of the same name.
866 LLVMTypeRef LLVMHalfType(void);
867 LLVMTypeRef LLVMFloatType(void);
868 LLVMTypeRef LLVMDoubleType(void);
869 LLVMTypeRef LLVMX86FP80Type(void);
870 LLVMTypeRef LLVMFP128Type(void);
871 LLVMTypeRef LLVMPPCFP128Type(void);
878 * @defgroup LLVMCCoreTypeFunction Function Types
884 * Obtain a function type consisting of a specified signature.
886 * The function is defined as a tuple of a return Type, a list of
887 * parameter types, and whether the function is variadic.
889 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
890 LLVMTypeRef *ParamTypes, unsigned ParamCount,
894 * Returns whether a function type is variadic.
896 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
899 * Obtain the Type this function Type returns.
901 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
904 * Obtain the number of parameters this function accepts.
906 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
909 * Obtain the types of a function's parameters.
911 * The Dest parameter should point to a pre-allocated array of
912 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
913 * first LLVMCountParamTypes() entries in the array will be populated
914 * with LLVMTypeRef instances.
916 * @param FunctionTy The function type to operate on.
917 * @param Dest Memory address of an array to be filled with result.
919 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
926 * @defgroup LLVMCCoreTypeStruct Structure Types
928 * These functions relate to LLVMTypeRef instances.
930 * @see llvm::StructType
936 * Create a new structure type in a context.
938 * A structure is specified by a list of inner elements/types and
939 * whether these can be packed together.
941 * @see llvm::StructType::create()
943 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
944 unsigned ElementCount, LLVMBool Packed);
947 * Create a new structure type in the global context.
949 * @see llvm::StructType::create()
951 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
955 * Create an empty structure in a context having a specified name.
957 * @see llvm::StructType::create()
959 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
962 * Obtain the name of a structure.
964 * @see llvm::StructType::getName()
966 const char *LLVMGetStructName(LLVMTypeRef Ty);
969 * Set the contents of a structure type.
971 * @see llvm::StructType::setBody()
973 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
974 unsigned ElementCount, LLVMBool Packed);
977 * Get the number of elements defined inside the structure.
979 * @see llvm::StructType::getNumElements()
981 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
984 * Get the elements within a structure.
986 * The function is passed the address of a pre-allocated array of
987 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
988 * invocation, this array will be populated with the structure's
989 * elements. The objects in the destination array will have a lifetime
990 * of the structure type itself, which is the lifetime of the context it
993 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
996 * Determine whether a structure is packed.
998 * @see llvm::StructType::isPacked()
1000 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
1003 * Determine whether a structure is opaque.
1005 * @see llvm::StructType::isOpaque()
1007 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
1015 * @defgroup LLVMCCoreTypeSequential Sequential Types
1017 * Sequential types represents "arrays" of types. This is a super class
1018 * for array, vector, and pointer types.
1024 * Obtain the type of elements within a sequential type.
1026 * This works on array, vector, and pointer types.
1028 * @see llvm::SequentialType::getElementType()
1030 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
1033 * Create a fixed size array type that refers to a specific type.
1035 * The created type will exist in the context that its element type
1038 * @see llvm::ArrayType::get()
1040 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
1043 * Obtain the length of an array type.
1045 * This only works on types that represent arrays.
1047 * @see llvm::ArrayType::getNumElements()
1049 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
1052 * Create a pointer type that points to a defined type.
1054 * The created type will exist in the context that its pointee type
1057 * @see llvm::PointerType::get()
1059 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
1062 * Obtain the address space of a pointer type.
1064 * This only works on types that represent pointers.
1066 * @see llvm::PointerType::getAddressSpace()
1068 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
1071 * Create a vector type that contains a defined type and has a specific
1072 * number of elements.
1074 * The created type will exist in the context thats its element type
1077 * @see llvm::VectorType::get()
1079 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
1082 * Obtain the number of elements in a vector type.
1084 * This only works on types that represent vectors.
1086 * @see llvm::VectorType::getNumElements()
1088 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1095 * @defgroup LLVMCCoreTypeOther Other Types
1101 * Create a void type in a context.
1103 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1106 * Create a label type in a context.
1108 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1111 * Create a X86 MMX type in a context.
1113 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1116 * These are similar to the above functions except they operate on the
1119 LLVMTypeRef LLVMVoidType(void);
1120 LLVMTypeRef LLVMLabelType(void);
1121 LLVMTypeRef LLVMX86MMXType(void);
1132 * @defgroup LLVMCCoreValues Values
1134 * The bulk of LLVM's object model consists of values, which comprise a very
1135 * rich type hierarchy.
1137 * LLVMValueRef essentially represents llvm::Value. There is a rich
1138 * hierarchy of classes within this type. Depending on the instance
1139 * obtained, not all APIs are available.
1141 * Callers can determine the type of an LLVMValueRef by calling the
1142 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1143 * functions are defined by a macro, so it isn't obvious which are
1144 * available by looking at the Doxygen source code. Instead, look at the
1145 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1146 * of value names given. These value names also correspond to classes in
1147 * the llvm::Value hierarchy.
1152 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1160 macro(BlockAddress) \
1161 macro(ConstantAggregateZero) \
1162 macro(ConstantArray) \
1163 macro(ConstantDataSequential) \
1164 macro(ConstantDataArray) \
1165 macro(ConstantDataVector) \
1166 macro(ConstantExpr) \
1168 macro(ConstantInt) \
1169 macro(ConstantPointerNull) \
1170 macro(ConstantStruct) \
1171 macro(ConstantVector) \
1172 macro(GlobalValue) \
1173 macro(GlobalAlias) \
1174 macro(GlobalObject) \
1176 macro(GlobalVariable) \
1178 macro(Instruction) \
1179 macro(BinaryOperator) \
1181 macro(IntrinsicInst) \
1182 macro(DbgInfoIntrinsic) \
1183 macro(DbgDeclareInst) \
1184 macro(MemIntrinsic) \
1186 macro(MemMoveInst) \
1191 macro(ExtractElementInst) \
1192 macro(GetElementPtrInst) \
1193 macro(InsertElementInst) \
1194 macro(InsertValueInst) \
1195 macro(LandingPadInst) \
1198 macro(ShuffleVectorInst) \
1200 macro(TerminatorInst) \
1202 macro(IndirectBrInst) \
1206 macro(UnreachableInst) \
1208 macro(UnaryInstruction) \
1211 macro(AddrSpaceCastInst) \
1212 macro(BitCastInst) \
1216 macro(FPTruncInst) \
1217 macro(IntToPtrInst) \
1218 macro(PtrToIntInst) \
1224 macro(ExtractValueInst) \
1229 * @defgroup LLVMCCoreValueGeneral General APIs
1231 * Functions in this section work on all LLVMValueRef instances,
1232 * regardless of their sub-type. They correspond to functions available
1239 * Obtain the type of a value.
1241 * @see llvm::Value::getType()
1243 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1246 * Obtain the string name of a value.
1248 * @see llvm::Value::getName()
1250 const char *LLVMGetValueName(LLVMValueRef Val);
1253 * Set the string name of a value.
1255 * @see llvm::Value::setName()
1257 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1260 * Dump a representation of a value to stderr.
1262 * @see llvm::Value::dump()
1264 void LLVMDumpValue(LLVMValueRef Val);
1267 * Return a string representation of the value. Use
1268 * LLVMDisposeMessage to free the string.
1270 * @see llvm::Value::print()
1272 char *LLVMPrintValueToString(LLVMValueRef Val);
1275 * Replace all uses of a value with another one.
1277 * @see llvm::Value::replaceAllUsesWith()
1279 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1282 * Determine whether the specified constant instance is constant.
1284 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1287 * Determine whether a value instance is undefined.
1289 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1292 * Convert value instances between types.
1294 * Internally, an LLVMValueRef is "pinned" to a specific type. This
1295 * series of functions allows you to cast an instance to a specific
1298 * If the cast is not valid for the specified type, NULL is returned.
1300 * @see llvm::dyn_cast_or_null<>
1302 #define LLVM_DECLARE_VALUE_CAST(name) \
1303 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1304 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1311 * @defgroup LLVMCCoreValueUses Usage
1313 * This module defines functions that allow you to inspect the uses of a
1316 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1317 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1318 * llvm::User and llvm::Value.
1324 * Obtain the first use of a value.
1326 * Uses are obtained in an iterator fashion. First, call this function
1327 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1328 * on that instance and all subsequently obtained instances until
1329 * LLVMGetNextUse() returns NULL.
1331 * @see llvm::Value::use_begin()
1333 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1336 * Obtain the next use of a value.
1338 * This effectively advances the iterator. It returns NULL if you are on
1339 * the final use and no more are available.
1341 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1344 * Obtain the user value for a user.
1346 * The returned value corresponds to a llvm::User type.
1348 * @see llvm::Use::getUser()
1350 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1353 * Obtain the value this use corresponds to.
1355 * @see llvm::Use::get().
1357 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1364 * @defgroup LLVMCCoreValueUser User value
1366 * Function in this group pertain to LLVMValueRef instances that descent
1367 * from llvm::User. This includes constants, instructions, and
1374 * Obtain an operand at a specific index in a llvm::User value.
1376 * @see llvm::User::getOperand()
1378 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1381 * Obtain the use of an operand at a specific index in a llvm::User value.
1383 * @see llvm::User::getOperandUse()
1385 LLVMUseRef LLVMGetOperandUse(LLVMValueRef Val, unsigned Index);
1388 * Set an operand at a specific index in a llvm::User value.
1390 * @see llvm::User::setOperand()
1392 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1395 * Obtain the number of operands in a llvm::User value.
1397 * @see llvm::User::getNumOperands()
1399 int LLVMGetNumOperands(LLVMValueRef Val);
1406 * @defgroup LLVMCCoreValueConstant Constants
1408 * This section contains APIs for interacting with LLVMValueRef that
1409 * correspond to llvm::Constant instances.
1411 * These functions will work for any LLVMValueRef in the llvm::Constant
1418 * Obtain a constant value referring to the null instance of a type.
1420 * @see llvm::Constant::getNullValue()
1422 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1425 * Obtain a constant value referring to the instance of a type
1426 * consisting of all ones.
1428 * This is only valid for integer types.
1430 * @see llvm::Constant::getAllOnesValue()
1432 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1435 * Obtain a constant value referring to an undefined value of a type.
1437 * @see llvm::UndefValue::get()
1439 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1442 * Determine whether a value instance is null.
1444 * @see llvm::Constant::isNullValue()
1446 LLVMBool LLVMIsNull(LLVMValueRef Val);
1449 * Obtain a constant that is a constant pointer pointing to NULL for a
1452 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1455 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1457 * Functions in this group model LLVMValueRef instances that correspond
1458 * to constants referring to scalar types.
1460 * For integer types, the LLVMTypeRef parameter should correspond to a
1461 * llvm::IntegerType instance and the returned LLVMValueRef will
1462 * correspond to a llvm::ConstantInt.
1464 * For floating point types, the LLVMTypeRef returned corresponds to a
1471 * Obtain a constant value for an integer type.
1473 * The returned value corresponds to a llvm::ConstantInt.
1475 * @see llvm::ConstantInt::get()
1477 * @param IntTy Integer type to obtain value of.
1478 * @param N The value the returned instance should refer to.
1479 * @param SignExtend Whether to sign extend the produced value.
1481 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1482 LLVMBool SignExtend);
1485 * Obtain a constant value for an integer of arbitrary precision.
1487 * @see llvm::ConstantInt::get()
1489 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1491 const uint64_t Words[]);
1494 * Obtain a constant value for an integer parsed from a string.
1496 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1497 * string's length is available, it is preferred to call that function
1500 * @see llvm::ConstantInt::get()
1502 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1506 * Obtain a constant value for an integer parsed from a string with
1509 * @see llvm::ConstantInt::get()
1511 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1512 unsigned SLen, uint8_t Radix);
1515 * Obtain a constant value referring to a double floating point value.
1517 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1520 * Obtain a constant for a floating point value parsed from a string.
1522 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1523 * should be used if the input string's length is known.
1525 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1528 * Obtain a constant for a floating point value parsed from a string.
1530 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1534 * Obtain the zero extended value for an integer constant value.
1536 * @see llvm::ConstantInt::getZExtValue()
1538 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1541 * Obtain the sign extended value for an integer constant value.
1543 * @see llvm::ConstantInt::getSExtValue()
1545 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1552 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1554 * Functions in this group operate on composite constants.
1560 * Create a ConstantDataSequential and initialize it with a string.
1562 * @see llvm::ConstantDataArray::getString()
1564 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1565 unsigned Length, LLVMBool DontNullTerminate);
1568 * Create a ConstantDataSequential with string content in the global context.
1570 * This is the same as LLVMConstStringInContext except it operates on the
1573 * @see LLVMConstStringInContext()
1574 * @see llvm::ConstantDataArray::getString()
1576 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1577 LLVMBool DontNullTerminate);
1580 * Returns true if the specified constant is an array of i8.
1582 * @see ConstantDataSequential::getAsString()
1584 LLVMBool LLVMIsConstantString(LLVMValueRef c);
1587 * Get the given constant data sequential as a string.
1589 * @see ConstantDataSequential::getAsString()
1591 const char *LLVMGetAsString(LLVMValueRef c, size_t* out);
1594 * Create an anonymous ConstantStruct with the specified values.
1596 * @see llvm::ConstantStruct::getAnon()
1598 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1599 LLVMValueRef *ConstantVals,
1600 unsigned Count, LLVMBool Packed);
1603 * Create a ConstantStruct in the global Context.
1605 * This is the same as LLVMConstStructInContext except it operates on the
1608 * @see LLVMConstStructInContext()
1610 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1614 * Create a ConstantArray from values.
1616 * @see llvm::ConstantArray::get()
1618 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1619 LLVMValueRef *ConstantVals, unsigned Length);
1622 * Create a non-anonymous ConstantStruct from values.
1624 * @see llvm::ConstantStruct::get()
1626 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1627 LLVMValueRef *ConstantVals,
1631 * Get an element at specified index as a constant.
1633 * @see ConstantDataSequential::getElementAsConstant()
1635 LLVMValueRef LLVMGetElementAsConstant(LLVMValueRef c, unsigned idx);
1638 * Create a ConstantVector from values.
1640 * @see llvm::ConstantVector::get()
1642 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1649 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1651 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1653 * @see llvm::ConstantExpr.
1657 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1658 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1659 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1660 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1661 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1662 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1663 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1664 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1665 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1666 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1667 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1668 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1669 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1670 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1671 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1672 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1673 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1674 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1675 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1676 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1677 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1678 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1679 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1680 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1681 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1682 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1683 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1684 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1685 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1686 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1687 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1688 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1689 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1690 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1691 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1692 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1693 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1694 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1695 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1696 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1697 LLVMValueRef *ConstantIndices,
1698 unsigned NumIndices);
1699 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1700 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1701 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1702 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1703 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1704 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1705 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1706 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1707 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1708 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1709 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1710 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1711 LLVMValueRef LLVMConstAddrSpaceCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1712 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1713 LLVMTypeRef ToType);
1714 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1715 LLVMTypeRef ToType);
1716 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1717 LLVMTypeRef ToType);
1718 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1719 LLVMTypeRef ToType);
1720 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1722 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1723 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1724 LLVMValueRef ConstantIfTrue,
1725 LLVMValueRef ConstantIfFalse);
1726 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1727 LLVMValueRef IndexConstant);
1728 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1729 LLVMValueRef ElementValueConstant,
1730 LLVMValueRef IndexConstant);
1731 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1732 LLVMValueRef VectorBConstant,
1733 LLVMValueRef MaskConstant);
1734 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1736 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1737 LLVMValueRef ElementValueConstant,
1738 unsigned *IdxList, unsigned NumIdx);
1739 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1740 const char *AsmString, const char *Constraints,
1741 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1742 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1749 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1751 * This group contains functions that operate on global values. Functions in
1752 * this group relate to functions in the llvm::GlobalValue class tree.
1754 * @see llvm::GlobalValue
1759 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1760 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1761 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1762 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1763 const char *LLVMGetSection(LLVMValueRef Global);
1764 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1765 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1766 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1767 LLVMDLLStorageClass LLVMGetDLLStorageClass(LLVMValueRef Global);
1768 void LLVMSetDLLStorageClass(LLVMValueRef Global, LLVMDLLStorageClass Class);
1769 LLVMBool LLVMHasUnnamedAddr(LLVMValueRef Global);
1770 void LLVMSetUnnamedAddr(LLVMValueRef Global, LLVMBool HasUnnamedAddr);
1773 * @defgroup LLVMCCoreValueWithAlignment Values with alignment
1775 * Functions in this group only apply to values with alignment, i.e.
1776 * global variables, load and store instructions.
1780 * Obtain the preferred alignment of the value.
1781 * @see llvm::AllocaInst::getAlignment()
1782 * @see llvm::LoadInst::getAlignment()
1783 * @see llvm::StoreInst::getAlignment()
1784 * @see llvm::GlobalValue::getAlignment()
1786 unsigned LLVMGetAlignment(LLVMValueRef V);
1789 * Set the preferred alignment of the value.
1790 * @see llvm::AllocaInst::setAlignment()
1791 * @see llvm::LoadInst::setAlignment()
1792 * @see llvm::StoreInst::setAlignment()
1793 * @see llvm::GlobalValue::setAlignment()
1795 void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes);
1802 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1804 * This group contains functions that operate on global variable values.
1806 * @see llvm::GlobalVariable
1810 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1811 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1813 unsigned AddressSpace);
1814 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1815 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1816 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1817 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1818 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1819 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1820 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1821 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1822 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1823 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1824 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1825 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1826 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1827 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1828 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1829 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1836 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1838 * This group contains function that operate on global alias values.
1840 * @see llvm::GlobalAlias
1844 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1852 * @defgroup LLVMCCoreValueFunction Function values
1854 * Functions in this group operate on LLVMValueRef instances that
1855 * correspond to llvm::Function instances.
1857 * @see llvm::Function
1863 * Remove a function from its containing module and deletes it.
1865 * @see llvm::Function::eraseFromParent()
1867 void LLVMDeleteFunction(LLVMValueRef Fn);
1870 * Obtain the ID number from a function instance.
1872 * @see llvm::Function::getIntrinsicID()
1874 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1877 * Obtain the calling function of a function.
1879 * The returned value corresponds to the LLVMCallConv enumeration.
1881 * @see llvm::Function::getCallingConv()
1883 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1886 * Set the calling convention of a function.
1888 * @see llvm::Function::setCallingConv()
1890 * @param Fn Function to operate on
1891 * @param CC LLVMCallConv to set calling convention to
1893 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1896 * Obtain the name of the garbage collector to use during code
1899 * @see llvm::Function::getGC()
1901 const char *LLVMGetGC(LLVMValueRef Fn);
1904 * Define the garbage collector to use during code generation.
1906 * @see llvm::Function::setGC()
1908 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1911 * Add an attribute to a function.
1913 * @see llvm::Function::addAttribute()
1915 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1918 * Add a target-dependent attribute to a fuction
1919 * @see llvm::AttrBuilder::addAttribute()
1921 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1925 * Obtain an attribute from a function.
1927 * @see llvm::Function::getAttributes()
1929 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1932 * Remove an attribute from a function.
1934 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1937 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1939 * Functions in this group relate to arguments/parameters on functions.
1941 * Functions in this group expect LLVMValueRef instances that correspond
1942 * to llvm::Function instances.
1948 * Obtain the number of parameters in a function.
1950 * @see llvm::Function::arg_size()
1952 unsigned LLVMCountParams(LLVMValueRef Fn);
1955 * Obtain the parameters in a function.
1957 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1958 * at least LLVMCountParams() long. This array will be filled with
1959 * LLVMValueRef instances which correspond to the parameters the
1960 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1963 * @see llvm::Function::arg_begin()
1965 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1968 * Obtain the parameter at the specified index.
1970 * Parameters are indexed from 0.
1972 * @see llvm::Function::arg_begin()
1974 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1977 * Obtain the function to which this argument belongs.
1979 * Unlike other functions in this group, this one takes an LLVMValueRef
1980 * that corresponds to a llvm::Attribute.
1982 * The returned LLVMValueRef is the llvm::Function to which this
1985 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1988 * Obtain the first parameter to a function.
1990 * @see llvm::Function::arg_begin()
1992 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1995 * Obtain the last parameter to a function.
1997 * @see llvm::Function::arg_end()
1999 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
2002 * Obtain the next parameter to a function.
2004 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
2005 * actually a wrapped iterator) and obtains the next parameter from the
2006 * underlying iterator.
2008 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
2011 * Obtain the previous parameter to a function.
2013 * This is the opposite of LLVMGetNextParam().
2015 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
2018 * Add an attribute to a function argument.
2020 * @see llvm::Argument::addAttr()
2022 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
2025 * Remove an attribute from a function argument.
2027 * @see llvm::Argument::removeAttr()
2029 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
2032 * Get an attribute from a function argument.
2034 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
2037 * Set the alignment for a function parameter.
2039 * @see llvm::Argument::addAttr()
2040 * @see llvm::AttrBuilder::addAlignmentAttr()
2042 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
2061 * @defgroup LLVMCCoreValueMetadata Metadata
2067 * Obtain a MDString value from a context.
2069 * The returned instance corresponds to the llvm::MDString class.
2071 * The instance is specified by string data of a specified length. The
2072 * string content is copied, so the backing memory can be freed after
2073 * this function returns.
2075 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
2079 * Obtain a MDString value from the global context.
2081 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
2084 * Obtain a MDNode value from a context.
2086 * The returned value corresponds to the llvm::MDNode class.
2088 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
2092 * Obtain a MDNode value from the global context.
2094 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
2097 * Obtain the underlying string from a MDString value.
2099 * @param V Instance to obtain string from.
2100 * @param Len Memory address which will hold length of returned string.
2101 * @return String data in MDString.
2103 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
2106 * Obtain the number of operands from an MDNode value.
2108 * @param V MDNode to get number of operands from.
2109 * @return Number of operands of the MDNode.
2111 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
2114 * Obtain the given MDNode's operands.
2116 * The passed LLVMValueRef pointer should point to enough memory to hold all of
2117 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
2118 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
2119 * MDNode's operands.
2121 * @param V MDNode to get the operands from.
2122 * @param Dest Destination array for operands.
2124 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
2131 * @defgroup LLVMCCoreValueBasicBlock Basic Block
2133 * A basic block represents a single entry single exit section of code.
2134 * Basic blocks contain a list of instructions which form the body of
2137 * Basic blocks belong to functions. They have the type of label.
2139 * Basic blocks are themselves values. However, the C API models them as
2140 * LLVMBasicBlockRef.
2142 * @see llvm::BasicBlock
2148 * Convert a basic block instance to a value type.
2150 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
2153 * Determine whether an LLVMValueRef is itself a basic block.
2155 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
2158 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
2160 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
2163 * Obtain the function to which a basic block belongs.
2165 * @see llvm::BasicBlock::getParent()
2167 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2170 * Obtain the terminator instruction for a basic block.
2172 * If the basic block does not have a terminator (it is not well-formed
2173 * if it doesn't), then NULL is returned.
2175 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2177 * @see llvm::BasicBlock::getTerminator()
2179 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2182 * Obtain the number of basic blocks in a function.
2184 * @param Fn Function value to operate on.
2186 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2189 * Obtain all of the basic blocks in a function.
2191 * This operates on a function value. The BasicBlocks parameter is a
2192 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2193 * LLVMCountBasicBlocks() in length. This array is populated with
2194 * LLVMBasicBlockRef instances.
2196 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2199 * Obtain the first basic block in a function.
2201 * The returned basic block can be used as an iterator. You will likely
2202 * eventually call into LLVMGetNextBasicBlock() with it.
2204 * @see llvm::Function::begin()
2206 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2209 * Obtain the last basic block in a function.
2211 * @see llvm::Function::end()
2213 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2216 * Advance a basic block iterator.
2218 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2221 * Go backwards in a basic block iterator.
2223 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2226 * Obtain the basic block that corresponds to the entry point of a
2229 * @see llvm::Function::getEntryBlock()
2231 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2234 * Append a basic block to the end of a function.
2236 * @see llvm::BasicBlock::Create()
2238 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2243 * Append a basic block to the end of a function using the global
2246 * @see llvm::BasicBlock::Create()
2248 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2251 * Insert a basic block in a function before another basic block.
2253 * The function to add to is determined by the function of the
2254 * passed basic block.
2256 * @see llvm::BasicBlock::Create()
2258 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2259 LLVMBasicBlockRef BB,
2263 * Insert a basic block in a function using the global context.
2265 * @see llvm::BasicBlock::Create()
2267 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2271 * Remove a basic block from a function and delete it.
2273 * This deletes the basic block from its containing function and deletes
2274 * the basic block itself.
2276 * @see llvm::BasicBlock::eraseFromParent()
2278 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2281 * Remove a basic block from a function.
2283 * This deletes the basic block from its containing function but keep
2284 * the basic block alive.
2286 * @see llvm::BasicBlock::removeFromParent()
2288 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2291 * Move a basic block to before another one.
2293 * @see llvm::BasicBlock::moveBefore()
2295 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2298 * Move a basic block to after another one.
2300 * @see llvm::BasicBlock::moveAfter()
2302 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2305 * Obtain the first instruction in a basic block.
2307 * The returned LLVMValueRef corresponds to a llvm::Instruction
2310 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2313 * Obtain the last instruction in a basic block.
2315 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2317 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2324 * @defgroup LLVMCCoreValueInstruction Instructions
2326 * Functions in this group relate to the inspection and manipulation of
2327 * individual instructions.
2329 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2330 * class has a large number of descendents. llvm::Instruction is a
2331 * llvm::Value and in the C API, instructions are modeled by
2334 * This group also contains sub-groups which operate on specific
2335 * llvm::Instruction types, e.g. llvm::CallInst.
2341 * Determine whether an instruction has any metadata attached.
2343 int LLVMHasMetadata(LLVMValueRef Val);
2346 * Return metadata associated with an instruction value.
2348 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2351 * Set metadata associated with an instruction value.
2353 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2356 * Obtain the basic block to which an instruction belongs.
2358 * @see llvm::Instruction::getParent()
2360 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2363 * Obtain the instruction that occurs after the one specified.
2365 * The next instruction will be from the same basic block.
2367 * If this is the last instruction in a basic block, NULL will be
2370 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2373 * Obtain the instruction that occurred before this one.
2375 * If the instruction is the first instruction in a basic block, NULL
2378 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2381 * Remove and delete an instruction.
2383 * The instruction specified is removed from its containing building
2384 * block and then deleted.
2386 * @see llvm::Instruction::eraseFromParent()
2388 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2391 * Obtain the code opcode for an individual instruction.
2393 * @see llvm::Instruction::getOpCode()
2395 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2398 * Obtain the predicate of an instruction.
2400 * This is only valid for instructions that correspond to llvm::ICmpInst
2401 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2403 * @see llvm::ICmpInst::getPredicate()
2405 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2408 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2410 * Functions in this group apply to instructions that refer to call
2411 * sites and invocations. These correspond to C++ types in the
2412 * llvm::CallInst class tree.
2418 * Set the calling convention for a call instruction.
2420 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2423 * @see llvm::CallInst::setCallingConv()
2424 * @see llvm::InvokeInst::setCallingConv()
2426 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2429 * Obtain the calling convention for a call instruction.
2431 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2434 * @see LLVMSetInstructionCallConv()
2436 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2439 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2440 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2442 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2446 * Obtain whether a call instruction is a tail call.
2448 * This only works on llvm::CallInst instructions.
2450 * @see llvm::CallInst::isTailCall()
2452 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2455 * Set whether a call instruction is a tail call.
2457 * This only works on llvm::CallInst instructions.
2459 * @see llvm::CallInst::setTailCall()
2461 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2468 * Obtain the default destination basic block of a switch instruction.
2470 * This only works on llvm::SwitchInst instructions.
2472 * @see llvm::SwitchInst::getDefaultDest()
2474 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2477 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2479 * Functions in this group only apply to instructions that map to
2480 * llvm::PHINode instances.
2486 * Add an incoming value to the end of a PHI list.
2488 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2489 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2492 * Obtain the number of incoming basic blocks to a PHI node.
2494 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2497 * Obtain an incoming value to a PHI node as an LLVMValueRef.
2499 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2502 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2504 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2519 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2521 * An instruction builder represents a point within a basic block and is
2522 * the exclusive means of building instructions using the C interface.
2527 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2528 LLVMBuilderRef LLVMCreateBuilder(void);
2529 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2530 LLVMValueRef Instr);
2531 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2532 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2533 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2534 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2535 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2536 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2538 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2541 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2542 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2543 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2546 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2547 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2548 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2550 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2551 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2552 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2553 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2554 LLVMBasicBlockRef Else, unsigned NumCases);
2555 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2557 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2558 LLVMValueRef *Args, unsigned NumArgs,
2559 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2561 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2562 LLVMValueRef PersFn, unsigned NumClauses,
2564 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2565 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2567 /* Add a case to the switch instruction */
2568 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2569 LLVMBasicBlockRef Dest);
2571 /* Add a destination to the indirectbr instruction */
2572 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2574 /* Add a catch or filter clause to the landingpad instruction */
2575 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2577 /* Set the 'cleanup' flag in the landingpad instruction */
2578 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2581 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2583 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2585 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2587 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2589 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2591 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2593 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2595 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2597 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2599 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2601 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2603 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2605 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2607 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2609 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2611 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2613 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2615 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2617 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2619 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2621 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2623 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2625 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2627 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2629 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2631 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2632 LLVMValueRef LHS, LLVMValueRef RHS,
2634 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2635 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2637 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2639 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2640 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2643 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2644 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2645 LLVMValueRef Val, const char *Name);
2646 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2647 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2648 LLVMValueRef Val, const char *Name);
2649 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2650 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2652 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2653 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2654 LLVMValueRef *Indices, unsigned NumIndices,
2656 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2657 LLVMValueRef *Indices, unsigned NumIndices,
2659 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2660 unsigned Idx, const char *Name);
2661 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2663 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2665 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2666 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2669 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2670 LLVMTypeRef DestTy, const char *Name);
2671 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2672 LLVMTypeRef DestTy, const char *Name);
2673 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2674 LLVMTypeRef DestTy, const char *Name);
2675 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2676 LLVMTypeRef DestTy, const char *Name);
2677 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2678 LLVMTypeRef DestTy, const char *Name);
2679 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2680 LLVMTypeRef DestTy, const char *Name);
2681 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2682 LLVMTypeRef DestTy, const char *Name);
2683 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2684 LLVMTypeRef DestTy, const char *Name);
2685 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2686 LLVMTypeRef DestTy, const char *Name);
2687 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2688 LLVMTypeRef DestTy, const char *Name);
2689 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2690 LLVMTypeRef DestTy, const char *Name);
2691 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2692 LLVMTypeRef DestTy, const char *Name);
2693 LLVMValueRef LLVMBuildAddrSpaceCast(LLVMBuilderRef, LLVMValueRef Val,
2694 LLVMTypeRef DestTy, const char *Name);
2695 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2696 LLVMTypeRef DestTy, const char *Name);
2697 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2698 LLVMTypeRef DestTy, const char *Name);
2699 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2700 LLVMTypeRef DestTy, const char *Name);
2701 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2702 LLVMTypeRef DestTy, const char *Name);
2703 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2704 LLVMTypeRef DestTy, const char *Name);
2705 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2706 LLVMTypeRef DestTy, const char *Name);
2707 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2708 LLVMTypeRef DestTy, const char *Name);
2711 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2712 LLVMValueRef LHS, LLVMValueRef RHS,
2714 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2715 LLVMValueRef LHS, LLVMValueRef RHS,
2718 /* Miscellaneous instructions */
2719 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2720 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2721 LLVMValueRef *Args, unsigned NumArgs,
2723 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2724 LLVMValueRef Then, LLVMValueRef Else,
2726 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2728 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2729 LLVMValueRef Index, const char *Name);
2730 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2731 LLVMValueRef EltVal, LLVMValueRef Index,
2733 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2734 LLVMValueRef V2, LLVMValueRef Mask,
2736 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2737 unsigned Index, const char *Name);
2738 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2739 LLVMValueRef EltVal, unsigned Index,
2742 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2744 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2746 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2747 LLVMValueRef RHS, const char *Name);
2748 LLVMValueRef LLVMBuildFence(LLVMBuilderRef B, LLVMAtomicOrdering ordering,
2749 LLVMBool singleThread, const char *Name);
2750 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B, LLVMAtomicRMWBinOp op,
2751 LLVMValueRef PTR, LLVMValueRef Val,
2752 LLVMAtomicOrdering ordering,
2753 LLVMBool singleThread);
2760 * @defgroup LLVMCCoreModuleProvider Module Providers
2766 * Changes the type of M so it can be passed to FunctionPassManagers and the
2767 * JIT. They take ModuleProviders for historical reasons.
2769 LLVMModuleProviderRef
2770 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2773 * Destroys the module M.
2775 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2782 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2787 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2788 LLVMMemoryBufferRef *OutMemBuf,
2790 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2792 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2793 size_t InputDataLength,
2794 const char *BufferName,
2795 LLVMBool RequiresNullTerminator);
2796 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2797 size_t InputDataLength,
2798 const char *BufferName);
2799 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2800 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2801 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2808 * @defgroup LLVMCCorePassRegistry Pass Registry
2813 /** Return the global pass registry, for use with initialization functions.
2814 @see llvm::PassRegistry::getPassRegistry */
2815 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2822 * @defgroup LLVMCCorePassManagers Pass Managers
2827 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2828 suitable for link-time optimization and whole-module transformations.
2829 @see llvm::PassManager::PassManager */
2830 LLVMPassManagerRef LLVMCreatePassManager(void);
2832 /** Constructs a new function-by-function pass pipeline over the module
2833 provider. It does not take ownership of the module provider. This type of
2834 pipeline is suitable for code generation and JIT compilation tasks.
2835 @see llvm::FunctionPassManager::FunctionPassManager */
2836 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2838 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2839 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2841 /** Initializes, executes on the provided module, and finalizes all of the
2842 passes scheduled in the pass manager. Returns 1 if any of the passes
2843 modified the module, 0 otherwise.
2844 @see llvm::PassManager::run(Module&) */
2845 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2847 /** Initializes all of the function passes scheduled in the function pass
2848 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2849 @see llvm::FunctionPassManager::doInitialization */
2850 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2852 /** Executes all of the function passes scheduled in the function pass manager
2853 on the provided function. Returns 1 if any of the passes modified the
2854 function, false otherwise.
2855 @see llvm::FunctionPassManager::run(Function&) */
2856 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2858 /** Finalizes all of the function passes scheduled in in the function pass
2859 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2860 @see llvm::FunctionPassManager::doFinalization */
2861 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2863 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2864 the module provider.
2865 @see llvm::PassManagerBase::~PassManagerBase. */
2866 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2873 * @defgroup LLVMCCoreThreading Threading
2875 * Handle the structures needed to make LLVM safe for multithreading.
2880 /** Deprecated: Multi-threading can only be enabled/disabled with the compile
2881 time define LLVM_ENABLE_THREADS. This function always returns
2882 LLVMIsMultithreaded(). */
2883 LLVMBool LLVMStartMultithreaded(void);
2885 /** Deprecated: Multi-threading can only be enabled/disabled with the compile
2886 time define LLVM_ENABLE_THREADS. */
2887 void LLVMStopMultithreaded(void);
2889 /** Check whether LLVM is executing in thread-safe mode or not.
2890 @see llvm::llvm_is_multithreaded */
2891 LLVMBool LLVMIsMultithreaded(void);
2907 #endif /* !defined(__cplusplus) */
2909 #endif /* !defined(LLVM_C_CORE_H) */