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,
564 * Return an exact copy of the specified module.
566 LLVMModuleRef LLVMCloneModule(LLVMModuleRef M);
569 * Destroy a module instance.
571 * This must be called for every created module or memory will be
574 void LLVMDisposeModule(LLVMModuleRef M);
577 * Obtain the data layout for a module.
579 * @see Module::getDataLayout()
581 const char *LLVMGetDataLayout(LLVMModuleRef M);
584 * Set the data layout for a module.
586 * @see Module::setDataLayout()
588 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
591 * Obtain the target triple for a module.
593 * @see Module::getTargetTriple()
595 const char *LLVMGetTarget(LLVMModuleRef M);
598 * Set the target triple for a module.
600 * @see Module::setTargetTriple()
602 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
605 * Dump a representation of a module to stderr.
607 * @see Module::dump()
609 void LLVMDumpModule(LLVMModuleRef M);
612 * Print a representation of a module to a file. The ErrorMessage needs to be
613 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
615 * @see Module::print()
617 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
618 char **ErrorMessage);
621 * Return a string representation of the module. Use
622 * LLVMDisposeMessage to free the string.
624 * @see Module::print()
626 char *LLVMPrintModuleToString(LLVMModuleRef M);
629 * Set inline assembly for a module.
631 * @see Module::setModuleInlineAsm()
633 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
636 * Obtain the context to which this module is associated.
638 * @see Module::getContext()
640 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
643 * Obtain a Type from a module by its registered name.
645 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
648 * Obtain the number of operands for named metadata in a module.
650 * @see llvm::Module::getNamedMetadata()
652 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
655 * Obtain the named metadata operands for a module.
657 * The passed LLVMValueRef pointer should refer to an array of
658 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
659 * array will be populated with the LLVMValueRef instances. Each
660 * instance corresponds to a llvm::MDNode.
662 * @see llvm::Module::getNamedMetadata()
663 * @see llvm::MDNode::getOperand()
665 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
668 * Add an operand to named metadata.
670 * @see llvm::Module::getNamedMetadata()
671 * @see llvm::MDNode::addOperand()
673 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
677 * Add a function to a module under a specified name.
679 * @see llvm::Function::Create()
681 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
682 LLVMTypeRef FunctionTy);
685 * Obtain a Function value from a Module by its name.
687 * The returned value corresponds to a llvm::Function value.
689 * @see llvm::Module::getFunction()
691 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
694 * Obtain an iterator to the first Function in a Module.
696 * @see llvm::Module::begin()
698 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
701 * Obtain an iterator to the last Function in a Module.
703 * @see llvm::Module::end()
705 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
708 * Advance a Function iterator to the next Function.
710 * Returns NULL if the iterator was already at the end and there are no more
713 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
716 * Decrement a Function iterator to the previous Function.
718 * Returns NULL if the iterator was already at the beginning and there are
719 * no previous functions.
721 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
728 * @defgroup LLVMCCoreType Types
730 * Types represent the type of a value.
732 * Types are associated with a context instance. The context internally
733 * deduplicates types so there is only 1 instance of a specific type
734 * alive at a time. In other words, a unique type is shared among all
735 * consumers within a context.
737 * A Type in the C API corresponds to llvm::Type.
739 * Types have the following hierarchy:
757 * Obtain the enumerated type of a Type instance.
759 * @see llvm::Type:getTypeID()
761 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
764 * Whether the type has a known size.
766 * Things that don't have a size are abstract types, labels, and void.a
768 * @see llvm::Type::isSized()
770 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
773 * Obtain the context to which this type instance is associated.
775 * @see llvm::Type::getContext()
777 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
780 * Dump a representation of a type to stderr.
782 * @see llvm::Type::dump()
784 void LLVMDumpType(LLVMTypeRef Val);
787 * Return a string representation of the type. Use
788 * LLVMDisposeMessage to free the string.
790 * @see llvm::Type::print()
792 char *LLVMPrintTypeToString(LLVMTypeRef Val);
795 * @defgroup LLVMCCoreTypeInt Integer Types
797 * Functions in this section operate on integer types.
803 * Obtain an integer type from a context with specified bit width.
805 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
806 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
807 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
808 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
809 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
810 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
813 * Obtain an integer type from the global context with a specified bit
816 LLVMTypeRef LLVMInt1Type(void);
817 LLVMTypeRef LLVMInt8Type(void);
818 LLVMTypeRef LLVMInt16Type(void);
819 LLVMTypeRef LLVMInt32Type(void);
820 LLVMTypeRef LLVMInt64Type(void);
821 LLVMTypeRef LLVMIntType(unsigned NumBits);
822 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
829 * @defgroup LLVMCCoreTypeFloat Floating Point Types
835 * Obtain a 16-bit floating point type from a context.
837 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
840 * Obtain a 32-bit floating point type from a context.
842 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
845 * Obtain a 64-bit floating point type from a context.
847 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
850 * Obtain a 80-bit floating point type (X87) from a context.
852 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
855 * Obtain a 128-bit floating point type (112-bit mantissa) from a
858 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
861 * Obtain a 128-bit floating point type (two 64-bits) from a context.
863 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
866 * Obtain a floating point type from the global context.
868 * These map to the functions in this group of the same name.
870 LLVMTypeRef LLVMHalfType(void);
871 LLVMTypeRef LLVMFloatType(void);
872 LLVMTypeRef LLVMDoubleType(void);
873 LLVMTypeRef LLVMX86FP80Type(void);
874 LLVMTypeRef LLVMFP128Type(void);
875 LLVMTypeRef LLVMPPCFP128Type(void);
882 * @defgroup LLVMCCoreTypeFunction Function Types
888 * Obtain a function type consisting of a specified signature.
890 * The function is defined as a tuple of a return Type, a list of
891 * parameter types, and whether the function is variadic.
893 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
894 LLVMTypeRef *ParamTypes, unsigned ParamCount,
898 * Returns whether a function type is variadic.
900 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
903 * Obtain the Type this function Type returns.
905 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
908 * Obtain the number of parameters this function accepts.
910 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
913 * Obtain the types of a function's parameters.
915 * The Dest parameter should point to a pre-allocated array of
916 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
917 * first LLVMCountParamTypes() entries in the array will be populated
918 * with LLVMTypeRef instances.
920 * @param FunctionTy The function type to operate on.
921 * @param Dest Memory address of an array to be filled with result.
923 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
930 * @defgroup LLVMCCoreTypeStruct Structure Types
932 * These functions relate to LLVMTypeRef instances.
934 * @see llvm::StructType
940 * Create a new structure type in a context.
942 * A structure is specified by a list of inner elements/types and
943 * whether these can be packed together.
945 * @see llvm::StructType::create()
947 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
948 unsigned ElementCount, LLVMBool Packed);
951 * Create a new structure type in the global context.
953 * @see llvm::StructType::create()
955 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
959 * Create an empty structure in a context having a specified name.
961 * @see llvm::StructType::create()
963 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
966 * Obtain the name of a structure.
968 * @see llvm::StructType::getName()
970 const char *LLVMGetStructName(LLVMTypeRef Ty);
973 * Set the contents of a structure type.
975 * @see llvm::StructType::setBody()
977 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
978 unsigned ElementCount, LLVMBool Packed);
981 * Get the number of elements defined inside the structure.
983 * @see llvm::StructType::getNumElements()
985 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
988 * Get the elements within a structure.
990 * The function is passed the address of a pre-allocated array of
991 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
992 * invocation, this array will be populated with the structure's
993 * elements. The objects in the destination array will have a lifetime
994 * of the structure type itself, which is the lifetime of the context it
997 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
1000 * Determine whether a structure is packed.
1002 * @see llvm::StructType::isPacked()
1004 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
1007 * Determine whether a structure is opaque.
1009 * @see llvm::StructType::isOpaque()
1011 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
1019 * @defgroup LLVMCCoreTypeSequential Sequential Types
1021 * Sequential types represents "arrays" of types. This is a super class
1022 * for array, vector, and pointer types.
1028 * Obtain the type of elements within a sequential type.
1030 * This works on array, vector, and pointer types.
1032 * @see llvm::SequentialType::getElementType()
1034 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
1037 * Create a fixed size array type that refers to a specific type.
1039 * The created type will exist in the context that its element type
1042 * @see llvm::ArrayType::get()
1044 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
1047 * Obtain the length of an array type.
1049 * This only works on types that represent arrays.
1051 * @see llvm::ArrayType::getNumElements()
1053 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
1056 * Create a pointer type that points to a defined type.
1058 * The created type will exist in the context that its pointee type
1061 * @see llvm::PointerType::get()
1063 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
1066 * Obtain the address space of a pointer type.
1068 * This only works on types that represent pointers.
1070 * @see llvm::PointerType::getAddressSpace()
1072 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
1075 * Create a vector type that contains a defined type and has a specific
1076 * number of elements.
1078 * The created type will exist in the context thats its element type
1081 * @see llvm::VectorType::get()
1083 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
1086 * Obtain the number of elements in a vector type.
1088 * This only works on types that represent vectors.
1090 * @see llvm::VectorType::getNumElements()
1092 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1099 * @defgroup LLVMCCoreTypeOther Other Types
1105 * Create a void type in a context.
1107 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1110 * Create a label type in a context.
1112 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1115 * Create a X86 MMX type in a context.
1117 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1120 * These are similar to the above functions except they operate on the
1123 LLVMTypeRef LLVMVoidType(void);
1124 LLVMTypeRef LLVMLabelType(void);
1125 LLVMTypeRef LLVMX86MMXType(void);
1136 * @defgroup LLVMCCoreValues Values
1138 * The bulk of LLVM's object model consists of values, which comprise a very
1139 * rich type hierarchy.
1141 * LLVMValueRef essentially represents llvm::Value. There is a rich
1142 * hierarchy of classes within this type. Depending on the instance
1143 * obtained, not all APIs are available.
1145 * Callers can determine the type of an LLVMValueRef by calling the
1146 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1147 * functions are defined by a macro, so it isn't obvious which are
1148 * available by looking at the Doxygen source code. Instead, look at the
1149 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1150 * of value names given. These value names also correspond to classes in
1151 * the llvm::Value hierarchy.
1156 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1164 macro(BlockAddress) \
1165 macro(ConstantAggregateZero) \
1166 macro(ConstantArray) \
1167 macro(ConstantDataSequential) \
1168 macro(ConstantDataArray) \
1169 macro(ConstantDataVector) \
1170 macro(ConstantExpr) \
1172 macro(ConstantInt) \
1173 macro(ConstantPointerNull) \
1174 macro(ConstantStruct) \
1175 macro(ConstantVector) \
1176 macro(GlobalValue) \
1177 macro(GlobalAlias) \
1178 macro(GlobalObject) \
1180 macro(GlobalVariable) \
1182 macro(Instruction) \
1183 macro(BinaryOperator) \
1185 macro(IntrinsicInst) \
1186 macro(DbgInfoIntrinsic) \
1187 macro(DbgDeclareInst) \
1188 macro(MemIntrinsic) \
1190 macro(MemMoveInst) \
1195 macro(ExtractElementInst) \
1196 macro(GetElementPtrInst) \
1197 macro(InsertElementInst) \
1198 macro(InsertValueInst) \
1199 macro(LandingPadInst) \
1202 macro(ShuffleVectorInst) \
1204 macro(TerminatorInst) \
1206 macro(IndirectBrInst) \
1210 macro(UnreachableInst) \
1212 macro(UnaryInstruction) \
1215 macro(AddrSpaceCastInst) \
1216 macro(BitCastInst) \
1220 macro(FPTruncInst) \
1221 macro(IntToPtrInst) \
1222 macro(PtrToIntInst) \
1228 macro(ExtractValueInst) \
1233 * @defgroup LLVMCCoreValueGeneral General APIs
1235 * Functions in this section work on all LLVMValueRef instances,
1236 * regardless of their sub-type. They correspond to functions available
1243 * Obtain the type of a value.
1245 * @see llvm::Value::getType()
1247 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1250 * Obtain the string name of a value.
1252 * @see llvm::Value::getName()
1254 const char *LLVMGetValueName(LLVMValueRef Val);
1257 * Set the string name of a value.
1259 * @see llvm::Value::setName()
1261 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1264 * Dump a representation of a value to stderr.
1266 * @see llvm::Value::dump()
1268 void LLVMDumpValue(LLVMValueRef Val);
1271 * Return a string representation of the value. Use
1272 * LLVMDisposeMessage to free the string.
1274 * @see llvm::Value::print()
1276 char *LLVMPrintValueToString(LLVMValueRef Val);
1279 * Replace all uses of a value with another one.
1281 * @see llvm::Value::replaceAllUsesWith()
1283 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1286 * Determine whether the specified constant instance is constant.
1288 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1291 * Determine whether a value instance is undefined.
1293 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1296 * Convert value instances between types.
1298 * Internally, an LLVMValueRef is "pinned" to a specific type. This
1299 * series of functions allows you to cast an instance to a specific
1302 * If the cast is not valid for the specified type, NULL is returned.
1304 * @see llvm::dyn_cast_or_null<>
1306 #define LLVM_DECLARE_VALUE_CAST(name) \
1307 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1308 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1315 * @defgroup LLVMCCoreValueUses Usage
1317 * This module defines functions that allow you to inspect the uses of a
1320 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1321 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1322 * llvm::User and llvm::Value.
1328 * Obtain the first use of a value.
1330 * Uses are obtained in an iterator fashion. First, call this function
1331 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1332 * on that instance and all subsequently obtained instances until
1333 * LLVMGetNextUse() returns NULL.
1335 * @see llvm::Value::use_begin()
1337 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1340 * Obtain the next use of a value.
1342 * This effectively advances the iterator. It returns NULL if you are on
1343 * the final use and no more are available.
1345 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1348 * Obtain the user value for a user.
1350 * The returned value corresponds to a llvm::User type.
1352 * @see llvm::Use::getUser()
1354 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1357 * Obtain the value this use corresponds to.
1359 * @see llvm::Use::get().
1361 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1368 * @defgroup LLVMCCoreValueUser User value
1370 * Function in this group pertain to LLVMValueRef instances that descent
1371 * from llvm::User. This includes constants, instructions, and
1378 * Obtain an operand at a specific index in a llvm::User value.
1380 * @see llvm::User::getOperand()
1382 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1385 * Obtain the use of an operand at a specific index in a llvm::User value.
1387 * @see llvm::User::getOperandUse()
1389 LLVMUseRef LLVMGetOperandUse(LLVMValueRef Val, unsigned Index);
1392 * Set an operand at a specific index in a llvm::User value.
1394 * @see llvm::User::setOperand()
1396 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1399 * Obtain the number of operands in a llvm::User value.
1401 * @see llvm::User::getNumOperands()
1403 int LLVMGetNumOperands(LLVMValueRef Val);
1410 * @defgroup LLVMCCoreValueConstant Constants
1412 * This section contains APIs for interacting with LLVMValueRef that
1413 * correspond to llvm::Constant instances.
1415 * These functions will work for any LLVMValueRef in the llvm::Constant
1422 * Obtain a constant value referring to the null instance of a type.
1424 * @see llvm::Constant::getNullValue()
1426 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1429 * Obtain a constant value referring to the instance of a type
1430 * consisting of all ones.
1432 * This is only valid for integer types.
1434 * @see llvm::Constant::getAllOnesValue()
1436 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1439 * Obtain a constant value referring to an undefined value of a type.
1441 * @see llvm::UndefValue::get()
1443 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1446 * Determine whether a value instance is null.
1448 * @see llvm::Constant::isNullValue()
1450 LLVMBool LLVMIsNull(LLVMValueRef Val);
1453 * Obtain a constant that is a constant pointer pointing to NULL for a
1456 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1459 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1461 * Functions in this group model LLVMValueRef instances that correspond
1462 * to constants referring to scalar types.
1464 * For integer types, the LLVMTypeRef parameter should correspond to a
1465 * llvm::IntegerType instance and the returned LLVMValueRef will
1466 * correspond to a llvm::ConstantInt.
1468 * For floating point types, the LLVMTypeRef returned corresponds to a
1475 * Obtain a constant value for an integer type.
1477 * The returned value corresponds to a llvm::ConstantInt.
1479 * @see llvm::ConstantInt::get()
1481 * @param IntTy Integer type to obtain value of.
1482 * @param N The value the returned instance should refer to.
1483 * @param SignExtend Whether to sign extend the produced value.
1485 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1486 LLVMBool SignExtend);
1489 * Obtain a constant value for an integer of arbitrary precision.
1491 * @see llvm::ConstantInt::get()
1493 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1495 const uint64_t Words[]);
1498 * Obtain a constant value for an integer parsed from a string.
1500 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1501 * string's length is available, it is preferred to call that function
1504 * @see llvm::ConstantInt::get()
1506 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1510 * Obtain a constant value for an integer parsed from a string with
1513 * @see llvm::ConstantInt::get()
1515 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1516 unsigned SLen, uint8_t Radix);
1519 * Obtain a constant value referring to a double floating point value.
1521 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1524 * Obtain a constant for a floating point value parsed from a string.
1526 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1527 * should be used if the input string's length is known.
1529 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1532 * Obtain a constant for a floating point value parsed from a string.
1534 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1538 * Obtain the zero extended value for an integer constant value.
1540 * @see llvm::ConstantInt::getZExtValue()
1542 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1545 * Obtain the sign extended value for an integer constant value.
1547 * @see llvm::ConstantInt::getSExtValue()
1549 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1556 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1558 * Functions in this group operate on composite constants.
1564 * Create a ConstantDataSequential and initialize it with a string.
1566 * @see llvm::ConstantDataArray::getString()
1568 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1569 unsigned Length, LLVMBool DontNullTerminate);
1572 * Create a ConstantDataSequential with string content in the global context.
1574 * This is the same as LLVMConstStringInContext except it operates on the
1577 * @see LLVMConstStringInContext()
1578 * @see llvm::ConstantDataArray::getString()
1580 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1581 LLVMBool DontNullTerminate);
1584 * Returns true if the specified constant is an array of i8.
1586 * @see ConstantDataSequential::getAsString()
1588 LLVMBool LLVMIsConstantString(LLVMValueRef c);
1591 * Get the given constant data sequential as a string.
1593 * @see ConstantDataSequential::getAsString()
1595 const char *LLVMGetAsString(LLVMValueRef c, size_t* out);
1598 * Create an anonymous ConstantStruct with the specified values.
1600 * @see llvm::ConstantStruct::getAnon()
1602 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1603 LLVMValueRef *ConstantVals,
1604 unsigned Count, LLVMBool Packed);
1607 * Create a ConstantStruct in the global Context.
1609 * This is the same as LLVMConstStructInContext except it operates on the
1612 * @see LLVMConstStructInContext()
1614 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1618 * Create a ConstantArray from values.
1620 * @see llvm::ConstantArray::get()
1622 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1623 LLVMValueRef *ConstantVals, unsigned Length);
1626 * Create a non-anonymous ConstantStruct from values.
1628 * @see llvm::ConstantStruct::get()
1630 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1631 LLVMValueRef *ConstantVals,
1635 * Get an element at specified index as a constant.
1637 * @see ConstantDataSequential::getElementAsConstant()
1639 LLVMValueRef LLVMGetElementAsConstant(LLVMValueRef c, unsigned idx);
1642 * Create a ConstantVector from values.
1644 * @see llvm::ConstantVector::get()
1646 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1653 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1655 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1657 * @see llvm::ConstantExpr.
1661 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1662 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1663 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1664 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1665 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1666 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1667 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1668 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1669 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1670 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1671 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1672 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1673 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1674 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1675 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1676 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1677 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1678 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1679 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1680 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1681 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1682 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1683 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1684 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1685 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1686 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1687 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1688 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1689 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1690 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1691 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1692 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1693 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1694 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1695 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1696 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1697 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1698 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1699 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1700 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1701 LLVMValueRef *ConstantIndices,
1702 unsigned NumIndices);
1703 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1704 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1705 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1706 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1707 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1708 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1709 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1710 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1711 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1712 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1713 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1714 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1715 LLVMValueRef LLVMConstAddrSpaceCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1716 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1717 LLVMTypeRef ToType);
1718 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1719 LLVMTypeRef ToType);
1720 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1721 LLVMTypeRef ToType);
1722 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1723 LLVMTypeRef ToType);
1724 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1726 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1727 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1728 LLVMValueRef ConstantIfTrue,
1729 LLVMValueRef ConstantIfFalse);
1730 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1731 LLVMValueRef IndexConstant);
1732 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1733 LLVMValueRef ElementValueConstant,
1734 LLVMValueRef IndexConstant);
1735 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1736 LLVMValueRef VectorBConstant,
1737 LLVMValueRef MaskConstant);
1738 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1740 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1741 LLVMValueRef ElementValueConstant,
1742 unsigned *IdxList, unsigned NumIdx);
1743 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1744 const char *AsmString, const char *Constraints,
1745 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1746 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1753 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1755 * This group contains functions that operate on global values. Functions in
1756 * this group relate to functions in the llvm::GlobalValue class tree.
1758 * @see llvm::GlobalValue
1763 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1764 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1765 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1766 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1767 const char *LLVMGetSection(LLVMValueRef Global);
1768 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1769 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1770 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1771 LLVMDLLStorageClass LLVMGetDLLStorageClass(LLVMValueRef Global);
1772 void LLVMSetDLLStorageClass(LLVMValueRef Global, LLVMDLLStorageClass Class);
1773 LLVMBool LLVMHasUnnamedAddr(LLVMValueRef Global);
1774 void LLVMSetUnnamedAddr(LLVMValueRef Global, LLVMBool HasUnnamedAddr);
1777 * @defgroup LLVMCCoreValueWithAlignment Values with alignment
1779 * Functions in this group only apply to values with alignment, i.e.
1780 * global variables, load and store instructions.
1784 * Obtain the preferred alignment of the value.
1785 * @see llvm::AllocaInst::getAlignment()
1786 * @see llvm::LoadInst::getAlignment()
1787 * @see llvm::StoreInst::getAlignment()
1788 * @see llvm::GlobalValue::getAlignment()
1790 unsigned LLVMGetAlignment(LLVMValueRef V);
1793 * Set the preferred alignment of the value.
1794 * @see llvm::AllocaInst::setAlignment()
1795 * @see llvm::LoadInst::setAlignment()
1796 * @see llvm::StoreInst::setAlignment()
1797 * @see llvm::GlobalValue::setAlignment()
1799 void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes);
1806 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1808 * This group contains functions that operate on global variable values.
1810 * @see llvm::GlobalVariable
1814 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1815 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1817 unsigned AddressSpace);
1818 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1819 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1820 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1821 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1822 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1823 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1824 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1825 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1826 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1827 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1828 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1829 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1830 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1831 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1832 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1833 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1840 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1842 * This group contains function that operate on global alias values.
1844 * @see llvm::GlobalAlias
1848 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1856 * @defgroup LLVMCCoreValueFunction Function values
1858 * Functions in this group operate on LLVMValueRef instances that
1859 * correspond to llvm::Function instances.
1861 * @see llvm::Function
1867 * Remove a function from its containing module and deletes it.
1869 * @see llvm::Function::eraseFromParent()
1871 void LLVMDeleteFunction(LLVMValueRef Fn);
1874 * Obtain the ID number from a function instance.
1876 * @see llvm::Function::getIntrinsicID()
1878 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1881 * Obtain the calling function of a function.
1883 * The returned value corresponds to the LLVMCallConv enumeration.
1885 * @see llvm::Function::getCallingConv()
1887 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1890 * Set the calling convention of a function.
1892 * @see llvm::Function::setCallingConv()
1894 * @param Fn Function to operate on
1895 * @param CC LLVMCallConv to set calling convention to
1897 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1900 * Obtain the name of the garbage collector to use during code
1903 * @see llvm::Function::getGC()
1905 const char *LLVMGetGC(LLVMValueRef Fn);
1908 * Define the garbage collector to use during code generation.
1910 * @see llvm::Function::setGC()
1912 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1915 * Add an attribute to a function.
1917 * @see llvm::Function::addAttribute()
1919 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1922 * Add a target-dependent attribute to a fuction
1923 * @see llvm::AttrBuilder::addAttribute()
1925 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1929 * Obtain an attribute from a function.
1931 * @see llvm::Function::getAttributes()
1933 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1936 * Remove an attribute from a function.
1938 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1941 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1943 * Functions in this group relate to arguments/parameters on functions.
1945 * Functions in this group expect LLVMValueRef instances that correspond
1946 * to llvm::Function instances.
1952 * Obtain the number of parameters in a function.
1954 * @see llvm::Function::arg_size()
1956 unsigned LLVMCountParams(LLVMValueRef Fn);
1959 * Obtain the parameters in a function.
1961 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1962 * at least LLVMCountParams() long. This array will be filled with
1963 * LLVMValueRef instances which correspond to the parameters the
1964 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1967 * @see llvm::Function::arg_begin()
1969 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1972 * Obtain the parameter at the specified index.
1974 * Parameters are indexed from 0.
1976 * @see llvm::Function::arg_begin()
1978 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1981 * Obtain the function to which this argument belongs.
1983 * Unlike other functions in this group, this one takes an LLVMValueRef
1984 * that corresponds to a llvm::Attribute.
1986 * The returned LLVMValueRef is the llvm::Function to which this
1989 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1992 * Obtain the first parameter to a function.
1994 * @see llvm::Function::arg_begin()
1996 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1999 * Obtain the last parameter to a function.
2001 * @see llvm::Function::arg_end()
2003 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
2006 * Obtain the next parameter to a function.
2008 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
2009 * actually a wrapped iterator) and obtains the next parameter from the
2010 * underlying iterator.
2012 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
2015 * Obtain the previous parameter to a function.
2017 * This is the opposite of LLVMGetNextParam().
2019 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
2022 * Add an attribute to a function argument.
2024 * @see llvm::Argument::addAttr()
2026 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
2029 * Remove an attribute from a function argument.
2031 * @see llvm::Argument::removeAttr()
2033 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
2036 * Get an attribute from a function argument.
2038 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
2041 * Set the alignment for a function parameter.
2043 * @see llvm::Argument::addAttr()
2044 * @see llvm::AttrBuilder::addAlignmentAttr()
2046 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
2065 * @defgroup LLVMCCoreValueMetadata Metadata
2071 * Obtain a MDString value from a context.
2073 * The returned instance corresponds to the llvm::MDString class.
2075 * The instance is specified by string data of a specified length. The
2076 * string content is copied, so the backing memory can be freed after
2077 * this function returns.
2079 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
2083 * Obtain a MDString value from the global context.
2085 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
2088 * Obtain a MDNode value from a context.
2090 * The returned value corresponds to the llvm::MDNode class.
2092 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
2096 * Obtain a MDNode value from the global context.
2098 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
2101 * Obtain the underlying string from a MDString value.
2103 * @param V Instance to obtain string from.
2104 * @param Len Memory address which will hold length of returned string.
2105 * @return String data in MDString.
2107 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
2110 * Obtain the number of operands from an MDNode value.
2112 * @param V MDNode to get number of operands from.
2113 * @return Number of operands of the MDNode.
2115 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
2118 * Obtain the given MDNode's operands.
2120 * The passed LLVMValueRef pointer should point to enough memory to hold all of
2121 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
2122 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
2123 * MDNode's operands.
2125 * @param V MDNode to get the operands from.
2126 * @param Dest Destination array for operands.
2128 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
2135 * @defgroup LLVMCCoreValueBasicBlock Basic Block
2137 * A basic block represents a single entry single exit section of code.
2138 * Basic blocks contain a list of instructions which form the body of
2141 * Basic blocks belong to functions. They have the type of label.
2143 * Basic blocks are themselves values. However, the C API models them as
2144 * LLVMBasicBlockRef.
2146 * @see llvm::BasicBlock
2152 * Convert a basic block instance to a value type.
2154 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
2157 * Determine whether an LLVMValueRef is itself a basic block.
2159 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
2162 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
2164 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
2167 * Obtain the function to which a basic block belongs.
2169 * @see llvm::BasicBlock::getParent()
2171 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2174 * Obtain the terminator instruction for a basic block.
2176 * If the basic block does not have a terminator (it is not well-formed
2177 * if it doesn't), then NULL is returned.
2179 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2181 * @see llvm::BasicBlock::getTerminator()
2183 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2186 * Obtain the number of basic blocks in a function.
2188 * @param Fn Function value to operate on.
2190 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2193 * Obtain all of the basic blocks in a function.
2195 * This operates on a function value. The BasicBlocks parameter is a
2196 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2197 * LLVMCountBasicBlocks() in length. This array is populated with
2198 * LLVMBasicBlockRef instances.
2200 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2203 * Obtain the first basic block in a function.
2205 * The returned basic block can be used as an iterator. You will likely
2206 * eventually call into LLVMGetNextBasicBlock() with it.
2208 * @see llvm::Function::begin()
2210 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2213 * Obtain the last basic block in a function.
2215 * @see llvm::Function::end()
2217 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2220 * Advance a basic block iterator.
2222 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2225 * Go backwards in a basic block iterator.
2227 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2230 * Obtain the basic block that corresponds to the entry point of a
2233 * @see llvm::Function::getEntryBlock()
2235 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2238 * Append a basic block to the end of a function.
2240 * @see llvm::BasicBlock::Create()
2242 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2247 * Append a basic block to the end of a function using the global
2250 * @see llvm::BasicBlock::Create()
2252 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2255 * Insert a basic block in a function before another basic block.
2257 * The function to add to is determined by the function of the
2258 * passed basic block.
2260 * @see llvm::BasicBlock::Create()
2262 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2263 LLVMBasicBlockRef BB,
2267 * Insert a basic block in a function using the global context.
2269 * @see llvm::BasicBlock::Create()
2271 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2275 * Remove a basic block from a function and delete it.
2277 * This deletes the basic block from its containing function and deletes
2278 * the basic block itself.
2280 * @see llvm::BasicBlock::eraseFromParent()
2282 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2285 * Remove a basic block from a function.
2287 * This deletes the basic block from its containing function but keep
2288 * the basic block alive.
2290 * @see llvm::BasicBlock::removeFromParent()
2292 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2295 * Move a basic block to before another one.
2297 * @see llvm::BasicBlock::moveBefore()
2299 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2302 * Move a basic block to after another one.
2304 * @see llvm::BasicBlock::moveAfter()
2306 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2309 * Obtain the first instruction in a basic block.
2311 * The returned LLVMValueRef corresponds to a llvm::Instruction
2314 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2317 * Obtain the last instruction in a basic block.
2319 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2321 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2328 * @defgroup LLVMCCoreValueInstruction Instructions
2330 * Functions in this group relate to the inspection and manipulation of
2331 * individual instructions.
2333 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2334 * class has a large number of descendents. llvm::Instruction is a
2335 * llvm::Value and in the C API, instructions are modeled by
2338 * This group also contains sub-groups which operate on specific
2339 * llvm::Instruction types, e.g. llvm::CallInst.
2345 * Determine whether an instruction has any metadata attached.
2347 int LLVMHasMetadata(LLVMValueRef Val);
2350 * Return metadata associated with an instruction value.
2352 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2355 * Set metadata associated with an instruction value.
2357 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2360 * Obtain the basic block to which an instruction belongs.
2362 * @see llvm::Instruction::getParent()
2364 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2367 * Obtain the instruction that occurs after the one specified.
2369 * The next instruction will be from the same basic block.
2371 * If this is the last instruction in a basic block, NULL will be
2374 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2377 * Obtain the instruction that occurred before this one.
2379 * If the instruction is the first instruction in a basic block, NULL
2382 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2385 * Remove and delete an instruction.
2387 * The instruction specified is removed from its containing building
2388 * block and then deleted.
2390 * @see llvm::Instruction::eraseFromParent()
2392 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2395 * Obtain the code opcode for an individual instruction.
2397 * @see llvm::Instruction::getOpCode()
2399 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2402 * Obtain the predicate of an instruction.
2404 * This is only valid for instructions that correspond to llvm::ICmpInst
2405 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2407 * @see llvm::ICmpInst::getPredicate()
2409 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2412 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2414 * Functions in this group apply to instructions that refer to call
2415 * sites and invocations. These correspond to C++ types in the
2416 * llvm::CallInst class tree.
2422 * Set the calling convention for a call instruction.
2424 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2427 * @see llvm::CallInst::setCallingConv()
2428 * @see llvm::InvokeInst::setCallingConv()
2430 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2433 * Obtain the calling convention for a call instruction.
2435 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2438 * @see LLVMSetInstructionCallConv()
2440 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2443 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2444 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2446 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2450 * Obtain whether a call instruction is a tail call.
2452 * This only works on llvm::CallInst instructions.
2454 * @see llvm::CallInst::isTailCall()
2456 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2459 * Set whether a call instruction is a tail call.
2461 * This only works on llvm::CallInst instructions.
2463 * @see llvm::CallInst::setTailCall()
2465 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2472 * Obtain the default destination basic block of a switch instruction.
2474 * This only works on llvm::SwitchInst instructions.
2476 * @see llvm::SwitchInst::getDefaultDest()
2478 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2481 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2483 * Functions in this group only apply to instructions that map to
2484 * llvm::PHINode instances.
2490 * Add an incoming value to the end of a PHI list.
2492 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2493 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2496 * Obtain the number of incoming basic blocks to a PHI node.
2498 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2501 * Obtain an incoming value to a PHI node as an LLVMValueRef.
2503 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2506 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2508 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2523 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2525 * An instruction builder represents a point within a basic block and is
2526 * the exclusive means of building instructions using the C interface.
2531 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2532 LLVMBuilderRef LLVMCreateBuilder(void);
2533 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2534 LLVMValueRef Instr);
2535 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2536 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2537 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2538 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2539 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2540 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2542 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2545 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2546 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2547 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2550 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2551 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2552 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2554 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2555 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2556 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2557 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2558 LLVMBasicBlockRef Else, unsigned NumCases);
2559 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2561 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2562 LLVMValueRef *Args, unsigned NumArgs,
2563 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2565 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2566 LLVMValueRef PersFn, unsigned NumClauses,
2568 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2569 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2571 /* Add a case to the switch instruction */
2572 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2573 LLVMBasicBlockRef Dest);
2575 /* Add a destination to the indirectbr instruction */
2576 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2578 /* Add a catch or filter clause to the landingpad instruction */
2579 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2581 /* Set the 'cleanup' flag in the landingpad instruction */
2582 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2585 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2587 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2589 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2591 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2593 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2595 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2597 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2599 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2601 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2603 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2605 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2607 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2609 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2611 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2613 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2615 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2617 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2619 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2621 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2623 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2625 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2627 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2629 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2631 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2633 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2635 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2636 LLVMValueRef LHS, LLVMValueRef RHS,
2638 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2639 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2641 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2643 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2644 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2647 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2648 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2649 LLVMValueRef Val, const char *Name);
2650 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2651 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2652 LLVMValueRef Val, const char *Name);
2653 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2654 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2656 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2657 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2658 LLVMValueRef *Indices, unsigned NumIndices,
2660 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2661 LLVMValueRef *Indices, unsigned NumIndices,
2663 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2664 unsigned Idx, const char *Name);
2665 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2667 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2669 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2670 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2673 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2674 LLVMTypeRef DestTy, const char *Name);
2675 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2676 LLVMTypeRef DestTy, const char *Name);
2677 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2678 LLVMTypeRef DestTy, const char *Name);
2679 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2680 LLVMTypeRef DestTy, const char *Name);
2681 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2682 LLVMTypeRef DestTy, const char *Name);
2683 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2684 LLVMTypeRef DestTy, const char *Name);
2685 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2686 LLVMTypeRef DestTy, const char *Name);
2687 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2688 LLVMTypeRef DestTy, const char *Name);
2689 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2690 LLVMTypeRef DestTy, const char *Name);
2691 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2692 LLVMTypeRef DestTy, const char *Name);
2693 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2694 LLVMTypeRef DestTy, const char *Name);
2695 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2696 LLVMTypeRef DestTy, const char *Name);
2697 LLVMValueRef LLVMBuildAddrSpaceCast(LLVMBuilderRef, LLVMValueRef Val,
2698 LLVMTypeRef DestTy, const char *Name);
2699 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2700 LLVMTypeRef DestTy, const char *Name);
2701 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2702 LLVMTypeRef DestTy, const char *Name);
2703 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2704 LLVMTypeRef DestTy, const char *Name);
2705 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2706 LLVMTypeRef DestTy, const char *Name);
2707 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2708 LLVMTypeRef DestTy, const char *Name);
2709 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2710 LLVMTypeRef DestTy, const char *Name);
2711 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2712 LLVMTypeRef DestTy, const char *Name);
2715 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2716 LLVMValueRef LHS, LLVMValueRef RHS,
2718 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2719 LLVMValueRef LHS, LLVMValueRef RHS,
2722 /* Miscellaneous instructions */
2723 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2724 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2725 LLVMValueRef *Args, unsigned NumArgs,
2727 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2728 LLVMValueRef Then, LLVMValueRef Else,
2730 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2732 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2733 LLVMValueRef Index, const char *Name);
2734 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2735 LLVMValueRef EltVal, LLVMValueRef Index,
2737 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2738 LLVMValueRef V2, LLVMValueRef Mask,
2740 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2741 unsigned Index, const char *Name);
2742 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2743 LLVMValueRef EltVal, unsigned Index,
2746 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2748 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2750 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2751 LLVMValueRef RHS, const char *Name);
2752 LLVMValueRef LLVMBuildFence(LLVMBuilderRef B, LLVMAtomicOrdering ordering,
2753 LLVMBool singleThread, const char *Name);
2754 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B, LLVMAtomicRMWBinOp op,
2755 LLVMValueRef PTR, LLVMValueRef Val,
2756 LLVMAtomicOrdering ordering,
2757 LLVMBool singleThread);
2764 * @defgroup LLVMCCoreModuleProvider Module Providers
2770 * Changes the type of M so it can be passed to FunctionPassManagers and the
2771 * JIT. They take ModuleProviders for historical reasons.
2773 LLVMModuleProviderRef
2774 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2777 * Destroys the module M.
2779 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2786 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2791 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2792 LLVMMemoryBufferRef *OutMemBuf,
2794 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2796 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2797 size_t InputDataLength,
2798 const char *BufferName,
2799 LLVMBool RequiresNullTerminator);
2800 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2801 size_t InputDataLength,
2802 const char *BufferName);
2803 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2804 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2805 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2812 * @defgroup LLVMCCorePassRegistry Pass Registry
2817 /** Return the global pass registry, for use with initialization functions.
2818 @see llvm::PassRegistry::getPassRegistry */
2819 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2826 * @defgroup LLVMCCorePassManagers Pass Managers
2831 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2832 suitable for link-time optimization and whole-module transformations.
2833 @see llvm::PassManager::PassManager */
2834 LLVMPassManagerRef LLVMCreatePassManager(void);
2836 /** Constructs a new function-by-function pass pipeline over the module
2837 provider. It does not take ownership of the module provider. This type of
2838 pipeline is suitable for code generation and JIT compilation tasks.
2839 @see llvm::FunctionPassManager::FunctionPassManager */
2840 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2842 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2843 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2845 /** Initializes, executes on the provided module, and finalizes all of the
2846 passes scheduled in the pass manager. Returns 1 if any of the passes
2847 modified the module, 0 otherwise.
2848 @see llvm::PassManager::run(Module&) */
2849 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2851 /** Initializes all of the function passes scheduled in the function pass
2852 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2853 @see llvm::FunctionPassManager::doInitialization */
2854 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2856 /** Executes all of the function passes scheduled in the function pass manager
2857 on the provided function. Returns 1 if any of the passes modified the
2858 function, false otherwise.
2859 @see llvm::FunctionPassManager::run(Function&) */
2860 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2862 /** Finalizes all of the function passes scheduled in in the function pass
2863 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2864 @see llvm::FunctionPassManager::doFinalization */
2865 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2867 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2868 the module provider.
2869 @see llvm::PassManagerBase::~PassManagerBase. */
2870 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2877 * @defgroup LLVMCCoreThreading Threading
2879 * Handle the structures needed to make LLVM safe for multithreading.
2884 /** Deprecated: Multi-threading can only be enabled/disabled with the compile
2885 time define LLVM_ENABLE_THREADS. This function always returns
2886 LLVMIsMultithreaded(). */
2887 LLVMBool LLVMStartMultithreaded(void);
2889 /** Deprecated: Multi-threading can only be enabled/disabled with the compile
2890 time define LLVM_ENABLE_THREADS. */
2891 void LLVMStopMultithreaded(void);
2893 /** Check whether LLVM is executing in thread-safe mode or not.
2894 @see llvm::llvm_is_multithreaded */
2895 LLVMBool LLVMIsMultithreaded(void);
2911 #endif /* !defined(__cplusplus) */
2913 #endif /* !defined(LLVM_C_CORE_H) */