1 /*===-- llvm-c/Core.h - Core Library C Interface ------------------*- C -*-===*\
3 |* The LLVM Compiler Infrastructure *|
5 |* This file is distributed under the University of Illinois Open Source *|
6 |* License. See LICENSE.TXT for details. *|
8 |*===----------------------------------------------------------------------===*|
10 |* This header declares the C interface to libLLVMCore.a, which implements *|
11 |* the LLVM intermediate representation. *|
13 \*===----------------------------------------------------------------------===*/
18 #include "llvm/Support/DataTypes.h"
25 * @defgroup LLVMC LLVM-C: C interface to LLVM
27 * This module exposes parts of the LLVM library as a C API.
33 * @defgroup LLVMCTransforms Transforms
37 * @defgroup LLVMCCore Core
39 * This modules provide an interface to libLLVMCore, which implements
40 * the LLVM intermediate representation as well as other related types
43 * LLVM uses a polymorphic type hierarchy which C cannot represent, therefore
44 * parameters must be passed as base types. Despite the declared types, most
45 * of the functions provided operate only on branches of the type hierarchy.
46 * The declared parameter names are descriptive and specify which type is
47 * required. Additionally, each type hierarchy is documented along with the
48 * functions that operate upon it. For more detail, refer to LLVM's C++ code.
49 * If in doubt, refer to Core.cpp, which performs parameter downcasts in the
50 * form unwrap<RequiredType>(Param).
52 * Many exotic languages can interoperate with C code but have a harder time
53 * with C++ due to name mangling. So in addition to C, this interface enables
54 * tools written in such languages.
60 * @defgroup LLVMCCoreTypes Types and Enumerations
70 * The top-level container for all LLVM global data. See the LLVMContext class.
72 typedef struct LLVMOpaqueContext *LLVMContextRef;
75 * The top-level container for all other LLVM Intermediate Representation (IR)
80 typedef struct LLVMOpaqueModule *LLVMModuleRef;
83 * Each value in the LLVM IR has a type, an LLVMTypeRef.
87 typedef struct LLVMOpaqueType *LLVMTypeRef;
90 * Represents an individual value in LLVM IR.
92 * This models llvm::Value.
94 typedef struct LLVMOpaqueValue *LLVMValueRef;
97 * Represents a basic block of instructions in LLVM IR.
99 * This models llvm::BasicBlock.
101 typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
104 * Represents an LLVM basic block builder.
106 * This models llvm::IRBuilder.
108 typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
111 * Interface used to provide a module to JIT or interpreter.
112 * This is now just a synonym for llvm::Module, but we have to keep using the
113 * different type to keep binary compatibility.
115 typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
118 * Used to provide a module to JIT or interpreter.
120 * @see llvm::MemoryBuffer
122 typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
124 /** @see llvm::PassManagerBase */
125 typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
127 /** @see llvm::PassRegistry */
128 typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef;
131 * Used to get the users and usees of a Value.
134 typedef struct LLVMOpaqueUse *LLVMUseRef;
137 LLVMZExtAttribute = 1<<0,
138 LLVMSExtAttribute = 1<<1,
139 LLVMNoReturnAttribute = 1<<2,
140 LLVMInRegAttribute = 1<<3,
141 LLVMStructRetAttribute = 1<<4,
142 LLVMNoUnwindAttribute = 1<<5,
143 LLVMNoAliasAttribute = 1<<6,
144 LLVMByValAttribute = 1<<7,
145 LLVMNestAttribute = 1<<8,
146 LLVMReadNoneAttribute = 1<<9,
147 LLVMReadOnlyAttribute = 1<<10,
148 LLVMNoInlineAttribute = 1<<11,
149 LLVMAlwaysInlineAttribute = 1<<12,
150 LLVMOptimizeForSizeAttribute = 1<<13,
151 LLVMStackProtectAttribute = 1<<14,
152 LLVMStackProtectReqAttribute = 1<<15,
153 LLVMAlignment = 31<<16,
154 LLVMNoCaptureAttribute = 1<<21,
155 LLVMNoRedZoneAttribute = 1<<22,
156 LLVMNoImplicitFloatAttribute = 1<<23,
157 LLVMNakedAttribute = 1<<24,
158 LLVMInlineHintAttribute = 1<<25,
159 LLVMStackAlignment = 7<<26,
160 LLVMReturnsTwice = 1 << 29,
161 LLVMUWTable = 1 << 30,
162 LLVMNonLazyBind = 1 << 31
164 /* FIXME: These attributes are currently not included in the C API as
165 a temporary measure until the API/ABI impact to the C API is understood
166 and the path forward agreed upon.
167 LLVMAddressSafety = 1ULL << 32,
168 LLVMStackProtectStrongAttribute = 1ULL<<33,
169 LLVMCold = 1ULL << 34,
170 LLVMOptimizeNone = 1ULL << 35
175 /* Terminator Instructions */
181 /* removed 6 due to API changes */
184 /* Standard Binary Operators */
198 /* Logical Operators */
206 /* Memory Operators */
210 LLVMGetElementPtr = 29,
226 /* Other Operators */
235 LLVMExtractElement = 50,
236 LLVMInsertElement = 51,
237 LLVMShuffleVector = 52,
238 LLVMExtractValue = 53,
239 LLVMInsertValue = 54,
241 /* Atomic operators */
243 LLVMAtomicCmpXchg = 56,
246 /* Exception Handling Operators */
253 LLVMVoidTypeKind, /**< type with no size */
254 LLVMHalfTypeKind, /**< 16 bit floating point type */
255 LLVMFloatTypeKind, /**< 32 bit floating point type */
256 LLVMDoubleTypeKind, /**< 64 bit floating point type */
257 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
258 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
259 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
260 LLVMLabelTypeKind, /**< Labels */
261 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
262 LLVMFunctionTypeKind, /**< Functions */
263 LLVMStructTypeKind, /**< Structures */
264 LLVMArrayTypeKind, /**< Arrays */
265 LLVMPointerTypeKind, /**< Pointers */
266 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
267 LLVMMetadataTypeKind, /**< Metadata */
268 LLVMX86_MMXTypeKind /**< X86 MMX */
272 LLVMExternalLinkage, /**< Externally visible function */
273 LLVMAvailableExternallyLinkage,
274 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
275 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
277 LLVMLinkOnceODRAutoHideLinkage, /**< Like LinkOnceODR, but possibly hidden. */
278 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
279 LLVMWeakODRLinkage, /**< Same, but only replaced by something
281 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
282 LLVMInternalLinkage, /**< Rename collisions when linking (static
284 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
285 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
286 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
287 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
288 LLVMGhostLinkage, /**< Obsolete */
289 LLVMCommonLinkage, /**< Tentative definitions */
290 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
291 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
295 LLVMDefaultVisibility, /**< The GV is visible */
296 LLVMHiddenVisibility, /**< The GV is hidden */
297 LLVMProtectedVisibility /**< The GV is protected */
302 LLVMFastCallConv = 8,
303 LLVMColdCallConv = 9,
304 LLVMX86StdcallCallConv = 64,
305 LLVMX86FastcallCallConv = 65
309 LLVMIntEQ = 32, /**< equal */
310 LLVMIntNE, /**< not equal */
311 LLVMIntUGT, /**< unsigned greater than */
312 LLVMIntUGE, /**< unsigned greater or equal */
313 LLVMIntULT, /**< unsigned less than */
314 LLVMIntULE, /**< unsigned less or equal */
315 LLVMIntSGT, /**< signed greater than */
316 LLVMIntSGE, /**< signed greater or equal */
317 LLVMIntSLT, /**< signed less than */
318 LLVMIntSLE /**< signed less or equal */
322 LLVMRealPredicateFalse, /**< Always false (always folded) */
323 LLVMRealOEQ, /**< True if ordered and equal */
324 LLVMRealOGT, /**< True if ordered and greater than */
325 LLVMRealOGE, /**< True if ordered and greater than or equal */
326 LLVMRealOLT, /**< True if ordered and less than */
327 LLVMRealOLE, /**< True if ordered and less than or equal */
328 LLVMRealONE, /**< True if ordered and operands are unequal */
329 LLVMRealORD, /**< True if ordered (no nans) */
330 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
331 LLVMRealUEQ, /**< True if unordered or equal */
332 LLVMRealUGT, /**< True if unordered or greater than */
333 LLVMRealUGE, /**< True if unordered, greater than, or equal */
334 LLVMRealULT, /**< True if unordered or less than */
335 LLVMRealULE, /**< True if unordered, less than, or equal */
336 LLVMRealUNE, /**< True if unordered or not equal */
337 LLVMRealPredicateTrue /**< Always true (always folded) */
341 LLVMLandingPadCatch, /**< A catch clause */
342 LLVMLandingPadFilter /**< A filter clause */
343 } LLVMLandingPadClauseTy;
346 LLVMNotThreadLocal = 0,
347 LLVMGeneralDynamicTLSModel,
348 LLVMLocalDynamicTLSModel,
349 LLVMInitialExecTLSModel,
350 LLVMLocalExecTLSModel
351 } LLVMThreadLocalMode;
354 LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */
355 LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees
356 somewhat sane results, lock free. */
357 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the
358 operations affecting a specific address,
359 a consistent ordering exists */
360 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort
361 necessary to acquire a lock to access other
362 memory with normal loads and stores. */
363 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with
364 a barrier of the sort necessary to release
366 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
367 Release barrier (for fences and
368 operations which both read and write
370 LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics
371 for loads and Release
372 semantics for stores.
373 Additionally, it guarantees
374 that a total ordering exists
376 SequentiallyConsistent
378 } LLVMAtomicOrdering;
381 LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */
382 LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */
383 LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */
384 LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */
385 LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */
386 LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */
387 LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */
388 LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the
389 original using a signed comparison and return
391 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
392 original using a signed comparison and return
394 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
395 original using an unsigned comparison and return
397 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
398 original using an unsigned comparison and return
400 } LLVMAtomicRMWBinOp;
406 void LLVMInitializeCore(LLVMPassRegistryRef R);
408 /** Deallocate and destroy all ManagedStatic variables.
409 @see llvm::llvm_shutdown
410 @see ManagedStatic */
411 void LLVMShutdown(void);
414 /*===-- Error handling ----------------------------------------------------===*/
416 char *LLVMCreateMessage(const char *Message);
417 void LLVMDisposeMessage(char *Message);
419 typedef void (*LLVMFatalErrorHandler)(const char *Reason);
422 * Install a fatal error handler. By default, if LLVM detects a fatal error, it
423 * will call exit(1). This may not be appropriate in many contexts. For example,
424 * doing exit(1) will bypass many crash reporting/tracing system tools. This
425 * function allows you to install a callback that will be invoked prior to the
428 void LLVMInstallFatalErrorHandler(LLVMFatalErrorHandler Handler);
431 * Reset the fatal error handler. This resets LLVM's fatal error handling
432 * behavior to the default.
434 void LLVMResetFatalErrorHandler(void);
437 * @defgroup LLVMCCoreContext Contexts
439 * Contexts are execution states for the core LLVM IR system.
441 * Most types are tied to a context instance. Multiple contexts can
442 * exist simultaneously. A single context is not thread safe. However,
443 * different contexts can execute on different threads simultaneously.
449 * Create a new context.
451 * Every call to this function should be paired with a call to
452 * LLVMContextDispose() or the context will leak memory.
454 LLVMContextRef LLVMContextCreate(void);
457 * Obtain the global context instance.
459 LLVMContextRef LLVMGetGlobalContext(void);
462 * Destroy a context instance.
464 * This should be called for every call to LLVMContextCreate() or memory
467 void LLVMContextDispose(LLVMContextRef C);
469 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
471 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
478 * @defgroup LLVMCCoreModule Modules
480 * Modules represent the top-level structure in an LLVM program. An LLVM
481 * module is effectively a translation unit or a collection of
482 * translation units merged together.
488 * Create a new, empty module in the global context.
490 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
491 * LLVMGetGlobalContext() as the context parameter.
493 * Every invocation should be paired with LLVMDisposeModule() or memory
496 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
499 * Create a new, empty module in a specific context.
501 * Every invocation should be paired with LLVMDisposeModule() or memory
504 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
508 * Destroy a module instance.
510 * This must be called for every created module or memory will be
513 void LLVMDisposeModule(LLVMModuleRef M);
516 * Obtain the data layout for a module.
518 * @see Module::getDataLayout()
520 const char *LLVMGetDataLayout(LLVMModuleRef M);
523 * Set the data layout for a module.
525 * @see Module::setDataLayout()
527 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
530 * Obtain the target triple for a module.
532 * @see Module::getTargetTriple()
534 const char *LLVMGetTarget(LLVMModuleRef M);
537 * Set the target triple for a module.
539 * @see Module::setTargetTriple()
541 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
544 * Dump a representation of a module to stderr.
546 * @see Module::dump()
548 void LLVMDumpModule(LLVMModuleRef M);
551 * Print a representation of a module to a file. The ErrorMessage needs to be
552 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
554 * @see Module::print()
556 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
557 char **ErrorMessage);
560 * Return a string representation of the module. Use
561 * LLVMDisposeMessage to free the string.
563 * @see Module::print()
565 char *LLVMPrintModuleToString(LLVMModuleRef M);
568 * Set inline assembly for a module.
570 * @see Module::setModuleInlineAsm()
572 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
575 * Obtain the context to which this module is associated.
577 * @see Module::getContext()
579 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
582 * Obtain a Type from a module by its registered name.
584 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
587 * Obtain the number of operands for named metadata in a module.
589 * @see llvm::Module::getNamedMetadata()
591 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
594 * Obtain the named metadata operands for a module.
596 * The passed LLVMValueRef pointer should refer to an array of
597 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
598 * array will be populated with the LLVMValueRef instances. Each
599 * instance corresponds to a llvm::MDNode.
601 * @see llvm::Module::getNamedMetadata()
602 * @see llvm::MDNode::getOperand()
604 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
607 * Add an operand to named metadata.
609 * @see llvm::Module::getNamedMetadata()
610 * @see llvm::MDNode::addOperand()
612 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
616 * Add a function to a module under a specified name.
618 * @see llvm::Function::Create()
620 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
621 LLVMTypeRef FunctionTy);
624 * Obtain a Function value from a Module by its name.
626 * The returned value corresponds to a llvm::Function value.
628 * @see llvm::Module::getFunction()
630 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
633 * Obtain an iterator to the first Function in a Module.
635 * @see llvm::Module::begin()
637 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
640 * Obtain an iterator to the last Function in a Module.
642 * @see llvm::Module::end()
644 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
647 * Advance a Function iterator to the next Function.
649 * Returns NULL if the iterator was already at the end and there are no more
652 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
655 * Decrement a Function iterator to the previous Function.
657 * Returns NULL if the iterator was already at the beginning and there are
658 * no previous functions.
660 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
667 * @defgroup LLVMCCoreType Types
669 * Types represent the type of a value.
671 * Types are associated with a context instance. The context internally
672 * deduplicates types so there is only 1 instance of a specific type
673 * alive at a time. In other words, a unique type is shared among all
674 * consumers within a context.
676 * A Type in the C API corresponds to llvm::Type.
678 * Types have the following hierarchy:
696 * Obtain the enumerated type of a Type instance.
698 * @see llvm::Type:getTypeID()
700 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
703 * Whether the type has a known size.
705 * Things that don't have a size are abstract types, labels, and void.a
707 * @see llvm::Type::isSized()
709 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
712 * Obtain the context to which this type instance is associated.
714 * @see llvm::Type::getContext()
716 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
719 * Dump a representation of a type to stderr.
721 * @see llvm::Type::dump()
723 void LLVMDumpType(LLVMTypeRef Val);
726 * Return a string representation of the type. Use
727 * LLVMDisposeMessage to free the string.
729 * @see llvm::Type::print()
731 char *LLVMPrintTypeToString(LLVMTypeRef Val);
734 * @defgroup LLVMCCoreTypeInt Integer Types
736 * Functions in this section operate on integer types.
742 * Obtain an integer type from a context with specified bit width.
744 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
745 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
746 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
747 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
748 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
749 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
752 * Obtain an integer type from the global context with a specified bit
755 LLVMTypeRef LLVMInt1Type(void);
756 LLVMTypeRef LLVMInt8Type(void);
757 LLVMTypeRef LLVMInt16Type(void);
758 LLVMTypeRef LLVMInt32Type(void);
759 LLVMTypeRef LLVMInt64Type(void);
760 LLVMTypeRef LLVMIntType(unsigned NumBits);
761 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
768 * @defgroup LLVMCCoreTypeFloat Floating Point Types
774 * Obtain a 16-bit floating point type from a context.
776 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
779 * Obtain a 32-bit floating point type from a context.
781 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
784 * Obtain a 64-bit floating point type from a context.
786 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
789 * Obtain a 80-bit floating point type (X87) from a context.
791 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
794 * Obtain a 128-bit floating point type (112-bit mantissa) from a
797 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
800 * Obtain a 128-bit floating point type (two 64-bits) from a context.
802 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
805 * Obtain a floating point type from the global context.
807 * These map to the functions in this group of the same name.
809 LLVMTypeRef LLVMHalfType(void);
810 LLVMTypeRef LLVMFloatType(void);
811 LLVMTypeRef LLVMDoubleType(void);
812 LLVMTypeRef LLVMX86FP80Type(void);
813 LLVMTypeRef LLVMFP128Type(void);
814 LLVMTypeRef LLVMPPCFP128Type(void);
821 * @defgroup LLVMCCoreTypeFunction Function Types
827 * Obtain a function type consisting of a specified signature.
829 * The function is defined as a tuple of a return Type, a list of
830 * parameter types, and whether the function is variadic.
832 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
833 LLVMTypeRef *ParamTypes, unsigned ParamCount,
837 * Returns whether a function type is variadic.
839 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
842 * Obtain the Type this function Type returns.
844 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
847 * Obtain the number of parameters this function accepts.
849 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
852 * Obtain the types of a function's parameters.
854 * The Dest parameter should point to a pre-allocated array of
855 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
856 * first LLVMCountParamTypes() entries in the array will be populated
857 * with LLVMTypeRef instances.
859 * @param FunctionTy The function type to operate on.
860 * @param Dest Memory address of an array to be filled with result.
862 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
869 * @defgroup LLVMCCoreTypeStruct Structure Types
871 * These functions relate to LLVMTypeRef instances.
873 * @see llvm::StructType
879 * Create a new structure type in a context.
881 * A structure is specified by a list of inner elements/types and
882 * whether these can be packed together.
884 * @see llvm::StructType::create()
886 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
887 unsigned ElementCount, LLVMBool Packed);
890 * Create a new structure type in the global context.
892 * @see llvm::StructType::create()
894 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
898 * Create an empty structure in a context having a specified name.
900 * @see llvm::StructType::create()
902 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
905 * Obtain the name of a structure.
907 * @see llvm::StructType::getName()
909 const char *LLVMGetStructName(LLVMTypeRef Ty);
912 * Set the contents of a structure type.
914 * @see llvm::StructType::setBody()
916 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
917 unsigned ElementCount, LLVMBool Packed);
920 * Get the number of elements defined inside the structure.
922 * @see llvm::StructType::getNumElements()
924 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
927 * Get the elements within a structure.
929 * The function is passed the address of a pre-allocated array of
930 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
931 * invocation, this array will be populated with the structure's
932 * elements. The objects in the destination array will have a lifetime
933 * of the structure type itself, which is the lifetime of the context it
936 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
939 * Determine whether a structure is packed.
941 * @see llvm::StructType::isPacked()
943 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
946 * Determine whether a structure is opaque.
948 * @see llvm::StructType::isOpaque()
950 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
958 * @defgroup LLVMCCoreTypeSequential Sequential Types
960 * Sequential types represents "arrays" of types. This is a super class
961 * for array, vector, and pointer types.
967 * Obtain the type of elements within a sequential type.
969 * This works on array, vector, and pointer types.
971 * @see llvm::SequentialType::getElementType()
973 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
976 * Create a fixed size array type that refers to a specific type.
978 * The created type will exist in the context that its element type
981 * @see llvm::ArrayType::get()
983 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
986 * Obtain the length of an array type.
988 * This only works on types that represent arrays.
990 * @see llvm::ArrayType::getNumElements()
992 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
995 * Create a pointer type that points to a defined type.
997 * The created type will exist in the context that its pointee type
1000 * @see llvm::PointerType::get()
1002 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
1005 * Obtain the address space of a pointer type.
1007 * This only works on types that represent pointers.
1009 * @see llvm::PointerType::getAddressSpace()
1011 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
1014 * Create a vector type that contains a defined type and has a specific
1015 * number of elements.
1017 * The created type will exist in the context thats its element type
1020 * @see llvm::VectorType::get()
1022 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
1025 * Obtain the number of elements in a vector type.
1027 * This only works on types that represent vectors.
1029 * @see llvm::VectorType::getNumElements()
1031 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1038 * @defgroup LLVMCCoreTypeOther Other Types
1044 * Create a void type in a context.
1046 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1049 * Create a label type in a context.
1051 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1054 * Create a X86 MMX type in a context.
1056 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1059 * These are similar to the above functions except they operate on the
1062 LLVMTypeRef LLVMVoidType(void);
1063 LLVMTypeRef LLVMLabelType(void);
1064 LLVMTypeRef LLVMX86MMXType(void);
1075 * @defgroup LLVMCCoreValues Values
1077 * The bulk of LLVM's object model consists of values, which comprise a very
1078 * rich type hierarchy.
1080 * LLVMValueRef essentially represents llvm::Value. There is a rich
1081 * hierarchy of classes within this type. Depending on the instance
1082 * obtained, not all APIs are available.
1084 * Callers can determine the type of an LLVMValueRef by calling the
1085 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1086 * functions are defined by a macro, so it isn't obvious which are
1087 * available by looking at the Doxygen source code. Instead, look at the
1088 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1089 * of value names given. These value names also correspond to classes in
1090 * the llvm::Value hierarchy.
1095 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1103 macro(BlockAddress) \
1104 macro(ConstantAggregateZero) \
1105 macro(ConstantArray) \
1106 macro(ConstantExpr) \
1108 macro(ConstantInt) \
1109 macro(ConstantPointerNull) \
1110 macro(ConstantStruct) \
1111 macro(ConstantVector) \
1112 macro(GlobalValue) \
1114 macro(GlobalAlias) \
1115 macro(GlobalVariable) \
1117 macro(Instruction) \
1118 macro(BinaryOperator) \
1120 macro(IntrinsicInst) \
1121 macro(DbgInfoIntrinsic) \
1122 macro(DbgDeclareInst) \
1123 macro(MemIntrinsic) \
1125 macro(MemMoveInst) \
1130 macro(ExtractElementInst) \
1131 macro(GetElementPtrInst) \
1132 macro(InsertElementInst) \
1133 macro(InsertValueInst) \
1134 macro(LandingPadInst) \
1137 macro(ShuffleVectorInst) \
1139 macro(TerminatorInst) \
1141 macro(IndirectBrInst) \
1145 macro(UnreachableInst) \
1147 macro(UnaryInstruction) \
1150 macro(BitCastInst) \
1154 macro(FPTruncInst) \
1155 macro(IntToPtrInst) \
1156 macro(PtrToIntInst) \
1162 macro(ExtractValueInst) \
1167 * @defgroup LLVMCCoreValueGeneral General APIs
1169 * Functions in this section work on all LLVMValueRef instances,
1170 * regardless of their sub-type. They correspond to functions available
1177 * Obtain the type of a value.
1179 * @see llvm::Value::getType()
1181 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1184 * Obtain the string name of a value.
1186 * @see llvm::Value::getName()
1188 const char *LLVMGetValueName(LLVMValueRef Val);
1191 * Set the string name of a value.
1193 * @see llvm::Value::setName()
1195 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1198 * Dump a representation of a value to stderr.
1200 * @see llvm::Value::dump()
1202 void LLVMDumpValue(LLVMValueRef Val);
1205 * Replace all uses of a value with another one.
1207 * @see llvm::Value::replaceAllUsesWith()
1209 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1212 * Determine whether the specified constant instance is constant.
1214 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1217 * Determine whether a value instance is undefined.
1219 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1222 * Convert value instances between types.
1224 * Internally, an LLVMValueRef is "pinned" to a specific type. This
1225 * series of functions allows you to cast an instance to a specific
1228 * If the cast is not valid for the specified type, NULL is returned.
1230 * @see llvm::dyn_cast_or_null<>
1232 #define LLVM_DECLARE_VALUE_CAST(name) \
1233 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1234 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1241 * @defgroup LLVMCCoreValueUses Usage
1243 * This module defines functions that allow you to inspect the uses of a
1246 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1247 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1248 * llvm::User and llvm::Value.
1254 * Obtain the first use of a value.
1256 * Uses are obtained in an iterator fashion. First, call this function
1257 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1258 * on that instance and all subsequently obtained instances until
1259 * LLVMGetNextUse() returns NULL.
1261 * @see llvm::Value::use_begin()
1263 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1266 * Obtain the next use of a value.
1268 * This effectively advances the iterator. It returns NULL if you are on
1269 * the final use and no more are available.
1271 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1274 * Obtain the user value for a user.
1276 * The returned value corresponds to a llvm::User type.
1278 * @see llvm::Use::getUser()
1280 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1283 * Obtain the value this use corresponds to.
1285 * @see llvm::Use::get().
1287 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1294 * @defgroup LLVMCCoreValueUser User value
1296 * Function in this group pertain to LLVMValueRef instances that descent
1297 * from llvm::User. This includes constants, instructions, and
1304 * Obtain an operand at a specific index in a llvm::User value.
1306 * @see llvm::User::getOperand()
1308 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1311 * Set an operand at a specific index in a llvm::User value.
1313 * @see llvm::User::setOperand()
1315 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1318 * Obtain the number of operands in a llvm::User value.
1320 * @see llvm::User::getNumOperands()
1322 int LLVMGetNumOperands(LLVMValueRef Val);
1329 * @defgroup LLVMCCoreValueConstant Constants
1331 * This section contains APIs for interacting with LLVMValueRef that
1332 * correspond to llvm::Constant instances.
1334 * These functions will work for any LLVMValueRef in the llvm::Constant
1341 * Obtain a constant value referring to the null instance of a type.
1343 * @see llvm::Constant::getNullValue()
1345 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1348 * Obtain a constant value referring to the instance of a type
1349 * consisting of all ones.
1351 * This is only valid for integer types.
1353 * @see llvm::Constant::getAllOnesValue()
1355 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1358 * Obtain a constant value referring to an undefined value of a type.
1360 * @see llvm::UndefValue::get()
1362 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1365 * Determine whether a value instance is null.
1367 * @see llvm::Constant::isNullValue()
1369 LLVMBool LLVMIsNull(LLVMValueRef Val);
1372 * Obtain a constant that is a constant pointer pointing to NULL for a
1375 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1378 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1380 * Functions in this group model LLVMValueRef instances that correspond
1381 * to constants referring to scalar types.
1383 * For integer types, the LLVMTypeRef parameter should correspond to a
1384 * llvm::IntegerType instance and the returned LLVMValueRef will
1385 * correspond to a llvm::ConstantInt.
1387 * For floating point types, the LLVMTypeRef returned corresponds to a
1394 * Obtain a constant value for an integer type.
1396 * The returned value corresponds to a llvm::ConstantInt.
1398 * @see llvm::ConstantInt::get()
1400 * @param IntTy Integer type to obtain value of.
1401 * @param N The value the returned instance should refer to.
1402 * @param SignExtend Whether to sign extend the produced value.
1404 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1405 LLVMBool SignExtend);
1408 * Obtain a constant value for an integer of arbitrary precision.
1410 * @see llvm::ConstantInt::get()
1412 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1414 const uint64_t Words[]);
1417 * Obtain a constant value for an integer parsed from a string.
1419 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1420 * string's length is available, it is preferred to call that function
1423 * @see llvm::ConstantInt::get()
1425 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1429 * Obtain a constant value for an integer parsed from a string with
1432 * @see llvm::ConstantInt::get()
1434 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1435 unsigned SLen, uint8_t Radix);
1438 * Obtain a constant value referring to a double floating point value.
1440 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1443 * Obtain a constant for a floating point value parsed from a string.
1445 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1446 * should be used if the input string's length is known.
1448 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1451 * Obtain a constant for a floating point value parsed from a string.
1453 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1457 * Obtain the zero extended value for an integer constant value.
1459 * @see llvm::ConstantInt::getZExtValue()
1461 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1464 * Obtain the sign extended value for an integer constant value.
1466 * @see llvm::ConstantInt::getSExtValue()
1468 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1475 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1477 * Functions in this group operate on composite constants.
1483 * Create a ConstantDataSequential and initialize it with a string.
1485 * @see llvm::ConstantDataArray::getString()
1487 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1488 unsigned Length, LLVMBool DontNullTerminate);
1491 * Create a ConstantDataSequential with string content in the global context.
1493 * This is the same as LLVMConstStringInContext except it operates on the
1496 * @see LLVMConstStringInContext()
1497 * @see llvm::ConstantDataArray::getString()
1499 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1500 LLVMBool DontNullTerminate);
1503 * Create an anonymous ConstantStruct with the specified values.
1505 * @see llvm::ConstantStruct::getAnon()
1507 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1508 LLVMValueRef *ConstantVals,
1509 unsigned Count, LLVMBool Packed);
1512 * Create a ConstantStruct in the global Context.
1514 * This is the same as LLVMConstStructInContext except it operates on the
1517 * @see LLVMConstStructInContext()
1519 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1523 * Create a ConstantArray from values.
1525 * @see llvm::ConstantArray::get()
1527 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1528 LLVMValueRef *ConstantVals, unsigned Length);
1531 * Create a non-anonymous ConstantStruct from values.
1533 * @see llvm::ConstantStruct::get()
1535 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1536 LLVMValueRef *ConstantVals,
1540 * Create a ConstantVector from values.
1542 * @see llvm::ConstantVector::get()
1544 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1551 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1553 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1555 * @see llvm::ConstantExpr.
1559 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1560 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1561 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1562 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1563 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1564 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1565 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1566 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1567 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1568 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1569 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1570 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1571 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1572 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1573 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1574 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1575 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1576 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1577 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1578 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1579 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1580 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1581 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1582 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1583 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1584 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1585 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1586 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1587 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1588 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1589 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1590 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1591 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1592 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1593 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1594 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1595 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1596 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1597 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1598 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1599 LLVMValueRef *ConstantIndices,
1600 unsigned NumIndices);
1601 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1602 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1603 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1604 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1605 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1606 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1607 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1608 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1609 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1610 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1611 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1612 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1613 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1614 LLVMTypeRef ToType);
1615 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1616 LLVMTypeRef ToType);
1617 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1618 LLVMTypeRef ToType);
1619 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1620 LLVMTypeRef ToType);
1621 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1623 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1624 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1625 LLVMValueRef ConstantIfTrue,
1626 LLVMValueRef ConstantIfFalse);
1627 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1628 LLVMValueRef IndexConstant);
1629 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1630 LLVMValueRef ElementValueConstant,
1631 LLVMValueRef IndexConstant);
1632 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1633 LLVMValueRef VectorBConstant,
1634 LLVMValueRef MaskConstant);
1635 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1637 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1638 LLVMValueRef ElementValueConstant,
1639 unsigned *IdxList, unsigned NumIdx);
1640 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1641 const char *AsmString, const char *Constraints,
1642 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1643 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1650 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1652 * This group contains functions that operate on global values. Functions in
1653 * this group relate to functions in the llvm::GlobalValue class tree.
1655 * @see llvm::GlobalValue
1660 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1661 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1662 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1663 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1664 const char *LLVMGetSection(LLVMValueRef Global);
1665 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1666 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1667 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1668 unsigned LLVMGetAlignment(LLVMValueRef Global);
1669 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
1672 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1674 * This group contains functions that operate on global variable values.
1676 * @see llvm::GlobalVariable
1680 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1681 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1683 unsigned AddressSpace);
1684 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1685 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1686 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1687 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1688 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1689 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1690 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1691 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1692 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1693 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1694 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1695 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1696 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1697 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1698 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1699 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1706 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1708 * This group contains function that operate on global alias values.
1710 * @see llvm::GlobalAlias
1714 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1722 * @defgroup LLVMCCoreValueFunction Function values
1724 * Functions in this group operate on LLVMValueRef instances that
1725 * correspond to llvm::Function instances.
1727 * @see llvm::Function
1733 * Remove a function from its containing module and deletes it.
1735 * @see llvm::Function::eraseFromParent()
1737 void LLVMDeleteFunction(LLVMValueRef Fn);
1740 * Obtain the ID number from a function instance.
1742 * @see llvm::Function::getIntrinsicID()
1744 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1747 * Obtain the calling function of a function.
1749 * The returned value corresponds to the LLVMCallConv enumeration.
1751 * @see llvm::Function::getCallingConv()
1753 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1756 * Set the calling convention of a function.
1758 * @see llvm::Function::setCallingConv()
1760 * @param Fn Function to operate on
1761 * @param CC LLVMCallConv to set calling convention to
1763 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1766 * Obtain the name of the garbage collector to use during code
1769 * @see llvm::Function::getGC()
1771 const char *LLVMGetGC(LLVMValueRef Fn);
1774 * Define the garbage collector to use during code generation.
1776 * @see llvm::Function::setGC()
1778 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1781 * Add an attribute to a function.
1783 * @see llvm::Function::addAttribute()
1785 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1788 * Add a target-dependent attribute to a fuction
1789 * @see llvm::AttrBuilder::addAttribute()
1791 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1795 * Obtain an attribute from a function.
1797 * @see llvm::Function::getAttributes()
1799 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1802 * Remove an attribute from a function.
1804 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1807 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1809 * Functions in this group relate to arguments/parameters on functions.
1811 * Functions in this group expect LLVMValueRef instances that correspond
1812 * to llvm::Function instances.
1818 * Obtain the number of parameters in a function.
1820 * @see llvm::Function::arg_size()
1822 unsigned LLVMCountParams(LLVMValueRef Fn);
1825 * Obtain the parameters in a function.
1827 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1828 * at least LLVMCountParams() long. This array will be filled with
1829 * LLVMValueRef instances which correspond to the parameters the
1830 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1833 * @see llvm::Function::arg_begin()
1835 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1838 * Obtain the parameter at the specified index.
1840 * Parameters are indexed from 0.
1842 * @see llvm::Function::arg_begin()
1844 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1847 * Obtain the function to which this argument belongs.
1849 * Unlike other functions in this group, this one takes an LLVMValueRef
1850 * that corresponds to a llvm::Attribute.
1852 * The returned LLVMValueRef is the llvm::Function to which this
1855 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1858 * Obtain the first parameter to a function.
1860 * @see llvm::Function::arg_begin()
1862 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1865 * Obtain the last parameter to a function.
1867 * @see llvm::Function::arg_end()
1869 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
1872 * Obtain the next parameter to a function.
1874 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
1875 * actually a wrapped iterator) and obtains the next parameter from the
1876 * underlying iterator.
1878 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
1881 * Obtain the previous parameter to a function.
1883 * This is the opposite of LLVMGetNextParam().
1885 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
1888 * Add an attribute to a function argument.
1890 * @see llvm::Argument::addAttr()
1892 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1895 * Remove an attribute from a function argument.
1897 * @see llvm::Argument::removeAttr()
1899 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1902 * Get an attribute from a function argument.
1904 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
1907 * Set the alignment for a function parameter.
1909 * @see llvm::Argument::addAttr()
1910 * @see llvm::AttrBuilder::addAlignmentAttr()
1912 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
1931 * @defgroup LLVMCCoreValueMetadata Metadata
1937 * Obtain a MDString value from a context.
1939 * The returned instance corresponds to the llvm::MDString class.
1941 * The instance is specified by string data of a specified length. The
1942 * string content is copied, so the backing memory can be freed after
1943 * this function returns.
1945 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
1949 * Obtain a MDString value from the global context.
1951 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
1954 * Obtain a MDNode value from a context.
1956 * The returned value corresponds to the llvm::MDNode class.
1958 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
1962 * Obtain a MDNode value from the global context.
1964 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
1967 * Obtain the underlying string from a MDString value.
1969 * @param V Instance to obtain string from.
1970 * @param Len Memory address which will hold length of returned string.
1971 * @return String data in MDString.
1973 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
1976 * Obtain the number of operands from an MDNode value.
1978 * @param V MDNode to get number of operands from.
1979 * @return Number of operands of the MDNode.
1981 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
1984 * Obtain the given MDNode's operands.
1986 * The passed LLVMValueRef pointer should point to enough memory to hold all of
1987 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
1988 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
1989 * MDNode's operands.
1991 * @param V MDNode to get the operands from.
1992 * @param Dest Destination array for operands.
1994 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
2001 * @defgroup LLVMCCoreValueBasicBlock Basic Block
2003 * A basic block represents a single entry single exit section of code.
2004 * Basic blocks contain a list of instructions which form the body of
2007 * Basic blocks belong to functions. They have the type of label.
2009 * Basic blocks are themselves values. However, the C API models them as
2010 * LLVMBasicBlockRef.
2012 * @see llvm::BasicBlock
2018 * Convert a basic block instance to a value type.
2020 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
2023 * Determine whether an LLVMValueRef is itself a basic block.
2025 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
2028 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
2030 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
2033 * Obtain the function to which a basic block belongs.
2035 * @see llvm::BasicBlock::getParent()
2037 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2040 * Obtain the terminator instruction for a basic block.
2042 * If the basic block does not have a terminator (it is not well-formed
2043 * if it doesn't), then NULL is returned.
2045 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2047 * @see llvm::BasicBlock::getTerminator()
2049 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2052 * Obtain the number of basic blocks in a function.
2054 * @param Fn Function value to operate on.
2056 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2059 * Obtain all of the basic blocks in a function.
2061 * This operates on a function value. The BasicBlocks parameter is a
2062 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2063 * LLVMCountBasicBlocks() in length. This array is populated with
2064 * LLVMBasicBlockRef instances.
2066 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2069 * Obtain the first basic block in a function.
2071 * The returned basic block can be used as an iterator. You will likely
2072 * eventually call into LLVMGetNextBasicBlock() with it.
2074 * @see llvm::Function::begin()
2076 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2079 * Obtain the last basic block in a function.
2081 * @see llvm::Function::end()
2083 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2086 * Advance a basic block iterator.
2088 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2091 * Go backwards in a basic block iterator.
2093 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2096 * Obtain the basic block that corresponds to the entry point of a
2099 * @see llvm::Function::getEntryBlock()
2101 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2104 * Append a basic block to the end of a function.
2106 * @see llvm::BasicBlock::Create()
2108 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2113 * Append a basic block to the end of a function using the global
2116 * @see llvm::BasicBlock::Create()
2118 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2121 * Insert a basic block in a function before another basic block.
2123 * The function to add to is determined by the function of the
2124 * passed basic block.
2126 * @see llvm::BasicBlock::Create()
2128 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2129 LLVMBasicBlockRef BB,
2133 * Insert a basic block in a function using the global context.
2135 * @see llvm::BasicBlock::Create()
2137 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2141 * Remove a basic block from a function and delete it.
2143 * This deletes the basic block from its containing function and deletes
2144 * the basic block itself.
2146 * @see llvm::BasicBlock::eraseFromParent()
2148 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2151 * Remove a basic block from a function.
2153 * This deletes the basic block from its containing function but keep
2154 * the basic block alive.
2156 * @see llvm::BasicBlock::removeFromParent()
2158 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2161 * Move a basic block to before another one.
2163 * @see llvm::BasicBlock::moveBefore()
2165 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2168 * Move a basic block to after another one.
2170 * @see llvm::BasicBlock::moveAfter()
2172 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2175 * Obtain the first instruction in a basic block.
2177 * The returned LLVMValueRef corresponds to a llvm::Instruction
2180 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2183 * Obtain the last instruction in a basic block.
2185 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2187 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2194 * @defgroup LLVMCCoreValueInstruction Instructions
2196 * Functions in this group relate to the inspection and manipulation of
2197 * individual instructions.
2199 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2200 * class has a large number of descendents. llvm::Instruction is a
2201 * llvm::Value and in the C API, instructions are modeled by
2204 * This group also contains sub-groups which operate on specific
2205 * llvm::Instruction types, e.g. llvm::CallInst.
2211 * Determine whether an instruction has any metadata attached.
2213 int LLVMHasMetadata(LLVMValueRef Val);
2216 * Return metadata associated with an instruction value.
2218 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2221 * Set metadata associated with an instruction value.
2223 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2226 * Obtain the basic block to which an instruction belongs.
2228 * @see llvm::Instruction::getParent()
2230 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2233 * Obtain the instruction that occurs after the one specified.
2235 * The next instruction will be from the same basic block.
2237 * If this is the last instruction in a basic block, NULL will be
2240 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2243 * Obtain the instruction that occurred before this one.
2245 * If the instruction is the first instruction in a basic block, NULL
2248 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2251 * Remove and delete an instruction.
2253 * The instruction specified is removed from its containing building
2254 * block and then deleted.
2256 * @see llvm::Instruction::eraseFromParent()
2258 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2261 * Obtain the code opcode for an individual instruction.
2263 * @see llvm::Instruction::getOpCode()
2265 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2268 * Obtain the predicate of an instruction.
2270 * This is only valid for instructions that correspond to llvm::ICmpInst
2271 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2273 * @see llvm::ICmpInst::getPredicate()
2275 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2278 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2280 * Functions in this group apply to instructions that refer to call
2281 * sites and invocations. These correspond to C++ types in the
2282 * llvm::CallInst class tree.
2288 * Set the calling convention for a call instruction.
2290 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2293 * @see llvm::CallInst::setCallingConv()
2294 * @see llvm::InvokeInst::setCallingConv()
2296 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2299 * Obtain the calling convention for a call instruction.
2301 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2304 * @see LLVMSetInstructionCallConv()
2306 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2309 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2310 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2312 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2316 * Obtain whether a call instruction is a tail call.
2318 * This only works on llvm::CallInst instructions.
2320 * @see llvm::CallInst::isTailCall()
2322 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2325 * Set whether a call instruction is a tail call.
2327 * This only works on llvm::CallInst instructions.
2329 * @see llvm::CallInst::setTailCall()
2331 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2338 * Obtain the default destination basic block of a switch instruction.
2340 * This only works on llvm::SwitchInst instructions.
2342 * @see llvm::SwitchInst::getDefaultDest()
2344 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2347 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2349 * Functions in this group only apply to instructions that map to
2350 * llvm::PHINode instances.
2356 * Add an incoming value to the end of a PHI list.
2358 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2359 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2362 * Obtain the number of incoming basic blocks to a PHI node.
2364 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2367 * Obtain an incoming value to a PHI node as an LLVMValueRef.
2369 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2372 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2374 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2389 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2391 * An instruction builder represents a point within a basic block and is
2392 * the exclusive means of building instructions using the C interface.
2397 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2398 LLVMBuilderRef LLVMCreateBuilder(void);
2399 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2400 LLVMValueRef Instr);
2401 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2402 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2403 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2404 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2405 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2406 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2408 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2411 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2412 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2413 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2416 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2417 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2418 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2420 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2421 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2422 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2423 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2424 LLVMBasicBlockRef Else, unsigned NumCases);
2425 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2427 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2428 LLVMValueRef *Args, unsigned NumArgs,
2429 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2431 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2432 LLVMValueRef PersFn, unsigned NumClauses,
2434 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2435 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2437 /* Add a case to the switch instruction */
2438 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2439 LLVMBasicBlockRef Dest);
2441 /* Add a destination to the indirectbr instruction */
2442 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2444 /* Add a catch or filter clause to the landingpad instruction */
2445 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2447 /* Set the 'cleanup' flag in the landingpad instruction */
2448 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2451 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2453 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2455 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2457 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2459 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2461 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2463 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2465 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2467 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2469 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2471 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2473 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2475 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2477 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2479 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2481 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2483 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2485 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2487 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2489 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2491 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2493 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2495 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2497 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2499 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2501 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2502 LLVMValueRef LHS, LLVMValueRef RHS,
2504 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2505 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2507 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2509 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2510 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2513 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2514 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2515 LLVMValueRef Val, const char *Name);
2516 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2517 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2518 LLVMValueRef Val, const char *Name);
2519 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2520 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2522 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2523 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2524 LLVMValueRef *Indices, unsigned NumIndices,
2526 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2527 LLVMValueRef *Indices, unsigned NumIndices,
2529 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2530 unsigned Idx, const char *Name);
2531 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2533 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2535 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2536 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2539 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2540 LLVMTypeRef DestTy, const char *Name);
2541 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2542 LLVMTypeRef DestTy, const char *Name);
2543 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2544 LLVMTypeRef DestTy, const char *Name);
2545 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2546 LLVMTypeRef DestTy, const char *Name);
2547 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2548 LLVMTypeRef DestTy, const char *Name);
2549 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2550 LLVMTypeRef DestTy, const char *Name);
2551 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2552 LLVMTypeRef DestTy, const char *Name);
2553 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2554 LLVMTypeRef DestTy, const char *Name);
2555 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2556 LLVMTypeRef DestTy, const char *Name);
2557 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2558 LLVMTypeRef DestTy, const char *Name);
2559 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2560 LLVMTypeRef DestTy, const char *Name);
2561 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2562 LLVMTypeRef DestTy, const char *Name);
2563 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2564 LLVMTypeRef DestTy, const char *Name);
2565 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2566 LLVMTypeRef DestTy, const char *Name);
2567 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2568 LLVMTypeRef DestTy, const char *Name);
2569 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2570 LLVMTypeRef DestTy, const char *Name);
2571 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2572 LLVMTypeRef DestTy, const char *Name);
2573 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2574 LLVMTypeRef DestTy, const char *Name);
2575 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2576 LLVMTypeRef DestTy, const char *Name);
2579 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2580 LLVMValueRef LHS, LLVMValueRef RHS,
2582 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2583 LLVMValueRef LHS, LLVMValueRef RHS,
2586 /* Miscellaneous instructions */
2587 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2588 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2589 LLVMValueRef *Args, unsigned NumArgs,
2591 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2592 LLVMValueRef Then, LLVMValueRef Else,
2594 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2596 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2597 LLVMValueRef Index, const char *Name);
2598 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2599 LLVMValueRef EltVal, LLVMValueRef Index,
2601 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2602 LLVMValueRef V2, LLVMValueRef Mask,
2604 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2605 unsigned Index, const char *Name);
2606 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2607 LLVMValueRef EltVal, unsigned Index,
2610 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2612 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2614 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2615 LLVMValueRef RHS, const char *Name);
2616 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B,LLVMAtomicRMWBinOp op,
2617 LLVMValueRef PTR, LLVMValueRef Val,
2618 LLVMAtomicOrdering ordering,
2619 LLVMBool singleThread);
2626 * @defgroup LLVMCCoreModuleProvider Module Providers
2632 * Changes the type of M so it can be passed to FunctionPassManagers and the
2633 * JIT. They take ModuleProviders for historical reasons.
2635 LLVMModuleProviderRef
2636 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2639 * Destroys the module M.
2641 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2648 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2653 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2654 LLVMMemoryBufferRef *OutMemBuf,
2656 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2658 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2659 size_t InputDataLength,
2660 const char *BufferName,
2661 LLVMBool RequiresNullTerminator);
2662 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2663 size_t InputDataLength,
2664 const char *BufferName);
2665 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2666 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2667 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2674 * @defgroup LLVMCCorePassRegistry Pass Registry
2679 /** Return the global pass registry, for use with initialization functions.
2680 @see llvm::PassRegistry::getPassRegistry */
2681 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2688 * @defgroup LLVMCCorePassManagers Pass Managers
2693 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2694 suitable for link-time optimization and whole-module transformations.
2695 @see llvm::PassManager::PassManager */
2696 LLVMPassManagerRef LLVMCreatePassManager(void);
2698 /** Constructs a new function-by-function pass pipeline over the module
2699 provider. It does not take ownership of the module provider. This type of
2700 pipeline is suitable for code generation and JIT compilation tasks.
2701 @see llvm::FunctionPassManager::FunctionPassManager */
2702 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2704 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2705 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2707 /** Initializes, executes on the provided module, and finalizes all of the
2708 passes scheduled in the pass manager. Returns 1 if any of the passes
2709 modified the module, 0 otherwise.
2710 @see llvm::PassManager::run(Module&) */
2711 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2713 /** Initializes all of the function passes scheduled in the function pass
2714 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2715 @see llvm::FunctionPassManager::doInitialization */
2716 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2718 /** Executes all of the function passes scheduled in the function pass manager
2719 on the provided function. Returns 1 if any of the passes modified the
2720 function, false otherwise.
2721 @see llvm::FunctionPassManager::run(Function&) */
2722 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2724 /** Finalizes all of the function passes scheduled in in the function pass
2725 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2726 @see llvm::FunctionPassManager::doFinalization */
2727 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2729 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2730 the module provider.
2731 @see llvm::PassManagerBase::~PassManagerBase. */
2732 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2739 * @defgroup LLVMCCoreThreading Threading
2741 * Handle the structures needed to make LLVM safe for multithreading.
2746 /** Allocate and initialize structures needed to make LLVM safe for
2747 multithreading. The return value indicates whether multithreaded
2748 initialization succeeded. Must be executed in isolation from all
2749 other LLVM api calls.
2750 @see llvm::llvm_start_multithreaded */
2751 LLVMBool LLVMStartMultithreaded(void);
2753 /** Deallocate structures necessary to make LLVM safe for multithreading.
2754 Must be executed in isolation from all other LLVM api calls.
2755 @see llvm::llvm_stop_multithreaded */
2756 void LLVMStopMultithreaded(void);
2758 /** Check whether LLVM is executing in thread-safe mode or not.
2759 @see llvm::llvm_is_multithreaded */
2760 LLVMBool LLVMIsMultithreaded(void);
2776 #endif /* !defined(__cplusplus) */
2778 #endif /* !defined(LLVM_C_CORE_H) */