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
173 /* Terminator Instructions */
179 /* removed 6 due to API changes */
182 /* Standard Binary Operators */
196 /* Logical Operators */
204 /* Memory Operators */
208 LLVMGetElementPtr = 29,
224 /* Other Operators */
233 LLVMExtractElement = 50,
234 LLVMInsertElement = 51,
235 LLVMShuffleVector = 52,
236 LLVMExtractValue = 53,
237 LLVMInsertValue = 54,
239 /* Atomic operators */
241 LLVMAtomicCmpXchg = 56,
244 /* Exception Handling Operators */
251 LLVMVoidTypeKind, /**< type with no size */
252 LLVMHalfTypeKind, /**< 16 bit floating point type */
253 LLVMFloatTypeKind, /**< 32 bit floating point type */
254 LLVMDoubleTypeKind, /**< 64 bit floating point type */
255 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
256 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
257 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
258 LLVMLabelTypeKind, /**< Labels */
259 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
260 LLVMFunctionTypeKind, /**< Functions */
261 LLVMStructTypeKind, /**< Structures */
262 LLVMArrayTypeKind, /**< Arrays */
263 LLVMPointerTypeKind, /**< Pointers */
264 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
265 LLVMMetadataTypeKind, /**< Metadata */
266 LLVMX86_MMXTypeKind /**< X86 MMX */
270 LLVMExternalLinkage, /**< Externally visible function */
271 LLVMAvailableExternallyLinkage,
272 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
273 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
275 LLVMLinkOnceODRAutoHideLinkage, /**< Like LinkOnceODR, but possibly hidden. */
276 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
277 LLVMWeakODRLinkage, /**< Same, but only replaced by something
279 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
280 LLVMInternalLinkage, /**< Rename collisions when linking (static
282 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
283 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
284 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
285 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
286 LLVMGhostLinkage, /**< Obsolete */
287 LLVMCommonLinkage, /**< Tentative definitions */
288 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
289 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
293 LLVMDefaultVisibility, /**< The GV is visible */
294 LLVMHiddenVisibility, /**< The GV is hidden */
295 LLVMProtectedVisibility /**< The GV is protected */
300 LLVMFastCallConv = 8,
301 LLVMColdCallConv = 9,
302 LLVMX86StdcallCallConv = 64,
303 LLVMX86FastcallCallConv = 65
307 LLVMIntEQ = 32, /**< equal */
308 LLVMIntNE, /**< not equal */
309 LLVMIntUGT, /**< unsigned greater than */
310 LLVMIntUGE, /**< unsigned greater or equal */
311 LLVMIntULT, /**< unsigned less than */
312 LLVMIntULE, /**< unsigned less or equal */
313 LLVMIntSGT, /**< signed greater than */
314 LLVMIntSGE, /**< signed greater or equal */
315 LLVMIntSLT, /**< signed less than */
316 LLVMIntSLE /**< signed less or equal */
320 LLVMRealPredicateFalse, /**< Always false (always folded) */
321 LLVMRealOEQ, /**< True if ordered and equal */
322 LLVMRealOGT, /**< True if ordered and greater than */
323 LLVMRealOGE, /**< True if ordered and greater than or equal */
324 LLVMRealOLT, /**< True if ordered and less than */
325 LLVMRealOLE, /**< True if ordered and less than or equal */
326 LLVMRealONE, /**< True if ordered and operands are unequal */
327 LLVMRealORD, /**< True if ordered (no nans) */
328 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
329 LLVMRealUEQ, /**< True if unordered or equal */
330 LLVMRealUGT, /**< True if unordered or greater than */
331 LLVMRealUGE, /**< True if unordered, greater than, or equal */
332 LLVMRealULT, /**< True if unordered or less than */
333 LLVMRealULE, /**< True if unordered, less than, or equal */
334 LLVMRealUNE, /**< True if unordered or not equal */
335 LLVMRealPredicateTrue /**< Always true (always folded) */
339 LLVMLandingPadCatch, /**< A catch clause */
340 LLVMLandingPadFilter /**< A filter clause */
341 } LLVMLandingPadClauseTy;
344 LLVMNotThreadLocal = 0,
345 LLVMGeneralDynamicTLSModel,
346 LLVMLocalDynamicTLSModel,
347 LLVMInitialExecTLSModel,
348 LLVMLocalExecTLSModel
349 } LLVMThreadLocalMode;
352 LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */
353 LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees
354 somewhat sane results, lock free. */
355 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the
356 operations affecting a specific address,
357 a consistent ordering exists */
358 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort
359 necessary to acquire a lock to access other
360 memory with normal loads and stores. */
361 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with
362 a barrier of the sort necessary to release
364 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
365 Release barrier (for fences and
366 operations which both read and write
368 LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics
369 for loads and Release
370 semantics for stores.
371 Additionally, it guarantees
372 that a total ordering exists
374 SequentiallyConsistent
376 } LLVMAtomicOrdering;
379 LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */
380 LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */
381 LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */
382 LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */
383 LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */
384 LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */
385 LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */
386 LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the
387 original using a signed comparison and return
389 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
390 original using a signed comparison and return
392 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
393 original using an unsigned comparison and return
395 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
396 original using an unsigned comparison and return
398 } LLVMAtomicRMWBinOp;
404 void LLVMInitializeCore(LLVMPassRegistryRef R);
406 /** Deallocate and destroy all ManagedStatic variables.
407 @see llvm::llvm_shutdown
408 @see ManagedStatic */
412 /*===-- Error handling ----------------------------------------------------===*/
414 char *LLVMCreateMessage(const char *Message);
415 void LLVMDisposeMessage(char *Message);
419 * @defgroup LLVMCCoreContext Contexts
421 * Contexts are execution states for the core LLVM IR system.
423 * Most types are tied to a context instance. Multiple contexts can
424 * exist simultaneously. A single context is not thread safe. However,
425 * different contexts can execute on different threads simultaneously.
431 * Create a new context.
433 * Every call to this function should be paired with a call to
434 * LLVMContextDispose() or the context will leak memory.
436 LLVMContextRef LLVMContextCreate(void);
439 * Obtain the global context instance.
441 LLVMContextRef LLVMGetGlobalContext(void);
444 * Destroy a context instance.
446 * This should be called for every call to LLVMContextCreate() or memory
449 void LLVMContextDispose(LLVMContextRef C);
451 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
453 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
460 * @defgroup LLVMCCoreModule Modules
462 * Modules represent the top-level structure in a LLVM program. An LLVM
463 * module is effectively a translation unit or a collection of
464 * translation units merged together.
470 * Create a new, empty module in the global context.
472 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
473 * LLVMGetGlobalContext() as the context parameter.
475 * Every invocation should be paired with LLVMDisposeModule() or memory
478 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
481 * Create a new, empty module in a specific context.
483 * Every invocation should be paired with LLVMDisposeModule() or memory
486 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
490 * Destroy a module instance.
492 * This must be called for every created module or memory will be
495 void LLVMDisposeModule(LLVMModuleRef M);
498 * Obtain the data layout for a module.
500 * @see Module::getDataLayout()
502 const char *LLVMGetDataLayout(LLVMModuleRef M);
505 * Set the data layout for a module.
507 * @see Module::setDataLayout()
509 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
512 * Obtain the target triple for a module.
514 * @see Module::getTargetTriple()
516 const char *LLVMGetTarget(LLVMModuleRef M);
519 * Set the target triple for a module.
521 * @see Module::setTargetTriple()
523 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
526 * Dump a representation of a module to stderr.
528 * @see Module::dump()
530 void LLVMDumpModule(LLVMModuleRef M);
533 * Print a representation of a module to a file. The ErrorMessage needs to be
534 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
536 * @see Module::print()
538 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
539 char **ErrorMessage);
542 * Set inline assembly for a module.
544 * @see Module::setModuleInlineAsm()
546 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
549 * Obtain the context to which this module is associated.
551 * @see Module::getContext()
553 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
556 * Obtain a Type from a module by its registered name.
558 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
561 * Obtain the number of operands for named metadata in a module.
563 * @see llvm::Module::getNamedMetadata()
565 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
568 * Obtain the named metadata operands for a module.
570 * The passed LLVMValueRef pointer should refer to an array of
571 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
572 * array will be populated with the LLVMValueRef instances. Each
573 * instance corresponds to a llvm::MDNode.
575 * @see llvm::Module::getNamedMetadata()
576 * @see llvm::MDNode::getOperand()
578 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
581 * Add an operand to named metadata.
583 * @see llvm::Module::getNamedMetadata()
584 * @see llvm::MDNode::addOperand()
586 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
590 * Add a function to a module under a specified name.
592 * @see llvm::Function::Create()
594 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
595 LLVMTypeRef FunctionTy);
598 * Obtain a Function value from a Module by its name.
600 * The returned value corresponds to a llvm::Function value.
602 * @see llvm::Module::getFunction()
604 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
607 * Obtain an iterator to the first Function in a Module.
609 * @see llvm::Module::begin()
611 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
614 * Obtain an iterator to the last Function in a Module.
616 * @see llvm::Module::end()
618 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
621 * Advance a Function iterator to the next Function.
623 * Returns NULL if the iterator was already at the end and there are no more
626 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
629 * Decrement a Function iterator to the previous Function.
631 * Returns NULL if the iterator was already at the beginning and there are
632 * no previous functions.
634 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
641 * @defgroup LLVMCCoreType Types
643 * Types represent the type of a value.
645 * Types are associated with a context instance. The context internally
646 * deduplicates types so there is only 1 instance of a specific type
647 * alive at a time. In other words, a unique type is shared among all
648 * consumers within a context.
650 * A Type in the C API corresponds to llvm::Type.
652 * Types have the following hierarchy:
670 * Obtain the enumerated type of a Type instance.
672 * @see llvm::Type:getTypeID()
674 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
677 * Whether the type has a known size.
679 * Things that don't have a size are abstract types, labels, and void.a
681 * @see llvm::Type::isSized()
683 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
686 * Obtain the context to which this type instance is associated.
688 * @see llvm::Type::getContext()
690 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
693 * @defgroup LLVMCCoreTypeInt Integer Types
695 * Functions in this section operate on integer types.
701 * Obtain an integer type from a context with specified bit width.
703 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
704 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
705 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
706 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
707 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
708 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
711 * Obtain an integer type from the global context with a specified bit
714 LLVMTypeRef LLVMInt1Type(void);
715 LLVMTypeRef LLVMInt8Type(void);
716 LLVMTypeRef LLVMInt16Type(void);
717 LLVMTypeRef LLVMInt32Type(void);
718 LLVMTypeRef LLVMInt64Type(void);
719 LLVMTypeRef LLVMIntType(unsigned NumBits);
720 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
727 * @defgroup LLVMCCoreTypeFloat Floating Point Types
733 * Obtain a 16-bit floating point type from a context.
735 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
738 * Obtain a 32-bit floating point type from a context.
740 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
743 * Obtain a 64-bit floating point type from a context.
745 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
748 * Obtain a 80-bit floating point type (X87) from a context.
750 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
753 * Obtain a 128-bit floating point type (112-bit mantissa) from a
756 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
759 * Obtain a 128-bit floating point type (two 64-bits) from a context.
761 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
764 * Obtain a floating point type from the global context.
766 * These map to the functions in this group of the same name.
768 LLVMTypeRef LLVMHalfType(void);
769 LLVMTypeRef LLVMFloatType(void);
770 LLVMTypeRef LLVMDoubleType(void);
771 LLVMTypeRef LLVMX86FP80Type(void);
772 LLVMTypeRef LLVMFP128Type(void);
773 LLVMTypeRef LLVMPPCFP128Type(void);
780 * @defgroup LLVMCCoreTypeFunction Function Types
786 * Obtain a function type consisting of a specified signature.
788 * The function is defined as a tuple of a return Type, a list of
789 * parameter types, and whether the function is variadic.
791 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
792 LLVMTypeRef *ParamTypes, unsigned ParamCount,
796 * Returns whether a function type is variadic.
798 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
801 * Obtain the Type this function Type returns.
803 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
806 * Obtain the number of parameters this function accepts.
808 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
811 * Obtain the types of a function's parameters.
813 * The Dest parameter should point to a pre-allocated array of
814 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
815 * first LLVMCountParamTypes() entries in the array will be populated
816 * with LLVMTypeRef instances.
818 * @param FunctionTy The function type to operate on.
819 * @param Dest Memory address of an array to be filled with result.
821 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
828 * @defgroup LLVMCCoreTypeStruct Structure Types
830 * These functions relate to LLVMTypeRef instances.
832 * @see llvm::StructType
838 * Create a new structure type in a context.
840 * A structure is specified by a list of inner elements/types and
841 * whether these can be packed together.
843 * @see llvm::StructType::create()
845 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
846 unsigned ElementCount, LLVMBool Packed);
849 * Create a new structure type in the global context.
851 * @see llvm::StructType::create()
853 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
857 * Create an empty structure in a context having a specified name.
859 * @see llvm::StructType::create()
861 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
864 * Obtain the name of a structure.
866 * @see llvm::StructType::getName()
868 const char *LLVMGetStructName(LLVMTypeRef Ty);
871 * Set the contents of a structure type.
873 * @see llvm::StructType::setBody()
875 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
876 unsigned ElementCount, LLVMBool Packed);
879 * Get the number of elements defined inside the structure.
881 * @see llvm::StructType::getNumElements()
883 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
886 * Get the elements within a structure.
888 * The function is passed the address of a pre-allocated array of
889 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
890 * invocation, this array will be populated with the structure's
891 * elements. The objects in the destination array will have a lifetime
892 * of the structure type itself, which is the lifetime of the context it
895 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
898 * Determine whether a structure is packed.
900 * @see llvm::StructType::isPacked()
902 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
905 * Determine whether a structure is opaque.
907 * @see llvm::StructType::isOpaque()
909 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
917 * @defgroup LLVMCCoreTypeSequential Sequential Types
919 * Sequential types represents "arrays" of types. This is a super class
920 * for array, vector, and pointer types.
926 * Obtain the type of elements within a sequential type.
928 * This works on array, vector, and pointer types.
930 * @see llvm::SequentialType::getElementType()
932 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
935 * Create a fixed size array type that refers to a specific type.
937 * The created type will exist in the context that its element type
940 * @see llvm::ArrayType::get()
942 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
945 * Obtain the length of an array type.
947 * This only works on types that represent arrays.
949 * @see llvm::ArrayType::getNumElements()
951 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
954 * Create a pointer type that points to a defined type.
956 * The created type will exist in the context that its pointee type
959 * @see llvm::PointerType::get()
961 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
964 * Obtain the address space of a pointer type.
966 * This only works on types that represent pointers.
968 * @see llvm::PointerType::getAddressSpace()
970 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
973 * Create a vector type that contains a defined type and has a specific
974 * number of elements.
976 * The created type will exist in the context thats its element type
979 * @see llvm::VectorType::get()
981 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
984 * Obtain the number of elements in a vector type.
986 * This only works on types that represent vectors.
988 * @see llvm::VectorType::getNumElements()
990 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
997 * @defgroup LLVMCCoreTypeOther Other Types
1003 * Create a void type in a context.
1005 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1008 * Create a label type in a context.
1010 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1013 * Create a X86 MMX type in a context.
1015 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1018 * These are similar to the above functions except they operate on the
1021 LLVMTypeRef LLVMVoidType(void);
1022 LLVMTypeRef LLVMLabelType(void);
1023 LLVMTypeRef LLVMX86MMXType(void);
1034 * @defgroup LLVMCCoreValues Values
1036 * The bulk of LLVM's object model consists of values, which comprise a very
1037 * rich type hierarchy.
1039 * LLVMValueRef essentially represents llvm::Value. There is a rich
1040 * hierarchy of classes within this type. Depending on the instance
1041 * obtained, not all APIs are available.
1043 * Callers can determine the type of a LLVMValueRef by calling the
1044 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1045 * functions are defined by a macro, so it isn't obvious which are
1046 * available by looking at the Doxygen source code. Instead, look at the
1047 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1048 * of value names given. These value names also correspond to classes in
1049 * the llvm::Value hierarchy.
1054 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1062 macro(BlockAddress) \
1063 macro(ConstantAggregateZero) \
1064 macro(ConstantArray) \
1065 macro(ConstantExpr) \
1067 macro(ConstantInt) \
1068 macro(ConstantPointerNull) \
1069 macro(ConstantStruct) \
1070 macro(ConstantVector) \
1071 macro(GlobalValue) \
1073 macro(GlobalAlias) \
1074 macro(GlobalVariable) \
1076 macro(Instruction) \
1077 macro(BinaryOperator) \
1079 macro(IntrinsicInst) \
1080 macro(DbgInfoIntrinsic) \
1081 macro(DbgDeclareInst) \
1082 macro(MemIntrinsic) \
1084 macro(MemMoveInst) \
1089 macro(ExtractElementInst) \
1090 macro(GetElementPtrInst) \
1091 macro(InsertElementInst) \
1092 macro(InsertValueInst) \
1093 macro(LandingPadInst) \
1096 macro(ShuffleVectorInst) \
1098 macro(TerminatorInst) \
1100 macro(IndirectBrInst) \
1104 macro(UnreachableInst) \
1106 macro(UnaryInstruction) \
1109 macro(BitCastInst) \
1113 macro(FPTruncInst) \
1114 macro(IntToPtrInst) \
1115 macro(PtrToIntInst) \
1121 macro(ExtractValueInst) \
1126 * @defgroup LLVMCCoreValueGeneral General APIs
1128 * Functions in this section work on all LLVMValueRef instances,
1129 * regardless of their sub-type. They correspond to functions available
1136 * Obtain the type of a value.
1138 * @see llvm::Value::getType()
1140 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1143 * Obtain the string name of a value.
1145 * @see llvm::Value::getName()
1147 const char *LLVMGetValueName(LLVMValueRef Val);
1150 * Set the string name of a value.
1152 * @see llvm::Value::setName()
1154 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1157 * Dump a representation of a value to stderr.
1159 * @see llvm::Value::dump()
1161 void LLVMDumpValue(LLVMValueRef Val);
1164 * Replace all uses of a value with another one.
1166 * @see llvm::Value::replaceAllUsesWith()
1168 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1171 * Determine whether the specified constant instance is constant.
1173 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1176 * Determine whether a value instance is undefined.
1178 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1181 * Convert value instances between types.
1183 * Internally, a LLVMValueRef is "pinned" to a specific type. This
1184 * series of functions allows you to cast an instance to a specific
1187 * If the cast is not valid for the specified type, NULL is returned.
1189 * @see llvm::dyn_cast_or_null<>
1191 #define LLVM_DECLARE_VALUE_CAST(name) \
1192 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1193 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1200 * @defgroup LLVMCCoreValueUses Usage
1202 * This module defines functions that allow you to inspect the uses of a
1205 * It is possible to obtain a LLVMUseRef for any LLVMValueRef instance.
1206 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1207 * llvm::User and llvm::Value.
1213 * Obtain the first use of a value.
1215 * Uses are obtained in an iterator fashion. First, call this function
1216 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1217 * on that instance and all subsequently obtained instances until
1218 * LLVMGetNextUse() returns NULL.
1220 * @see llvm::Value::use_begin()
1222 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1225 * Obtain the next use of a value.
1227 * This effectively advances the iterator. It returns NULL if you are on
1228 * the final use and no more are available.
1230 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1233 * Obtain the user value for a user.
1235 * The returned value corresponds to a llvm::User type.
1237 * @see llvm::Use::getUser()
1239 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1242 * Obtain the value this use corresponds to.
1244 * @see llvm::Use::get().
1246 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1253 * @defgroup LLVMCCoreValueUser User value
1255 * Function in this group pertain to LLVMValueRef instances that descent
1256 * from llvm::User. This includes constants, instructions, and
1263 * Obtain an operand at a specific index in a llvm::User value.
1265 * @see llvm::User::getOperand()
1267 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1270 * Set an operand at a specific index in a llvm::User value.
1272 * @see llvm::User::setOperand()
1274 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1277 * Obtain the number of operands in a llvm::User value.
1279 * @see llvm::User::getNumOperands()
1281 int LLVMGetNumOperands(LLVMValueRef Val);
1288 * @defgroup LLVMCCoreValueConstant Constants
1290 * This section contains APIs for interacting with LLVMValueRef that
1291 * correspond to llvm::Constant instances.
1293 * These functions will work for any LLVMValueRef in the llvm::Constant
1300 * Obtain a constant value referring to the null instance of a type.
1302 * @see llvm::Constant::getNullValue()
1304 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1307 * Obtain a constant value referring to the instance of a type
1308 * consisting of all ones.
1310 * This is only valid for integer types.
1312 * @see llvm::Constant::getAllOnesValue()
1314 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1317 * Obtain a constant value referring to an undefined value of a type.
1319 * @see llvm::UndefValue::get()
1321 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1324 * Determine whether a value instance is null.
1326 * @see llvm::Constant::isNullValue()
1328 LLVMBool LLVMIsNull(LLVMValueRef Val);
1331 * Obtain a constant that is a constant pointer pointing to NULL for a
1334 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1337 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1339 * Functions in this group model LLVMValueRef instances that correspond
1340 * to constants referring to scalar types.
1342 * For integer types, the LLVMTypeRef parameter should correspond to a
1343 * llvm::IntegerType instance and the returned LLVMValueRef will
1344 * correspond to a llvm::ConstantInt.
1346 * For floating point types, the LLVMTypeRef returned corresponds to a
1353 * Obtain a constant value for an integer type.
1355 * The returned value corresponds to a llvm::ConstantInt.
1357 * @see llvm::ConstantInt::get()
1359 * @param IntTy Integer type to obtain value of.
1360 * @param N The value the returned instance should refer to.
1361 * @param SignExtend Whether to sign extend the produced value.
1363 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1364 LLVMBool SignExtend);
1367 * Obtain a constant value for an integer of arbitrary precision.
1369 * @see llvm::ConstantInt::get()
1371 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1373 const uint64_t Words[]);
1376 * Obtain a constant value for an integer parsed from a string.
1378 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1379 * string's length is available, it is preferred to call that function
1382 * @see llvm::ConstantInt::get()
1384 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1388 * Obtain a constant value for an integer parsed from a string with
1391 * @see llvm::ConstantInt::get()
1393 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1394 unsigned SLen, uint8_t Radix);
1397 * Obtain a constant value referring to a double floating point value.
1399 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1402 * Obtain a constant for a floating point value parsed from a string.
1404 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1405 * should be used if the input string's length is known.
1407 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1410 * Obtain a constant for a floating point value parsed from a string.
1412 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1416 * Obtain the zero extended value for an integer constant value.
1418 * @see llvm::ConstantInt::getZExtValue()
1420 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1423 * Obtain the sign extended value for an integer constant value.
1425 * @see llvm::ConstantInt::getSExtValue()
1427 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1434 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1436 * Functions in this group operate on composite constants.
1442 * Create a ConstantDataSequential and initialize it with a string.
1444 * @see llvm::ConstantDataArray::getString()
1446 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1447 unsigned Length, LLVMBool DontNullTerminate);
1450 * Create a ConstantDataSequential with string content in the global context.
1452 * This is the same as LLVMConstStringInContext except it operates on the
1455 * @see LLVMConstStringInContext()
1456 * @see llvm::ConstantDataArray::getString()
1458 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1459 LLVMBool DontNullTerminate);
1462 * Create an anonymous ConstantStruct with the specified values.
1464 * @see llvm::ConstantStruct::getAnon()
1466 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1467 LLVMValueRef *ConstantVals,
1468 unsigned Count, LLVMBool Packed);
1471 * Create a ConstantStruct in the global Context.
1473 * This is the same as LLVMConstStructInContext except it operates on the
1476 * @see LLVMConstStructInContext()
1478 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1482 * Create a ConstantArray from values.
1484 * @see llvm::ConstantArray::get()
1486 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1487 LLVMValueRef *ConstantVals, unsigned Length);
1490 * Create a non-anonymous ConstantStruct from values.
1492 * @see llvm::ConstantStruct::get()
1494 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1495 LLVMValueRef *ConstantVals,
1499 * Create a ConstantVector from values.
1501 * @see llvm::ConstantVector::get()
1503 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1510 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1512 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1514 * @see llvm::ConstantExpr.
1518 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1519 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1520 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1521 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1522 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1523 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1524 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1525 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1526 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1527 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1528 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1529 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1530 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1531 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1532 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1533 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1534 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1535 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1536 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1537 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1538 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1539 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1540 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1541 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1542 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1543 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1544 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1545 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1546 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1547 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1548 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1549 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1550 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1551 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1552 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1553 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1554 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1555 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1556 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1557 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1558 LLVMValueRef *ConstantIndices,
1559 unsigned NumIndices);
1560 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1561 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1562 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1563 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1564 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1565 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1566 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1567 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1568 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1569 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1570 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1571 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1572 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1573 LLVMTypeRef ToType);
1574 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1575 LLVMTypeRef ToType);
1576 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1577 LLVMTypeRef ToType);
1578 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1579 LLVMTypeRef ToType);
1580 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1582 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1583 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1584 LLVMValueRef ConstantIfTrue,
1585 LLVMValueRef ConstantIfFalse);
1586 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1587 LLVMValueRef IndexConstant);
1588 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1589 LLVMValueRef ElementValueConstant,
1590 LLVMValueRef IndexConstant);
1591 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1592 LLVMValueRef VectorBConstant,
1593 LLVMValueRef MaskConstant);
1594 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1596 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1597 LLVMValueRef ElementValueConstant,
1598 unsigned *IdxList, unsigned NumIdx);
1599 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1600 const char *AsmString, const char *Constraints,
1601 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1602 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1609 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1611 * This group contains functions that operate on global values. Functions in
1612 * this group relate to functions in the llvm::GlobalValue class tree.
1614 * @see llvm::GlobalValue
1619 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1620 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1621 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1622 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1623 const char *LLVMGetSection(LLVMValueRef Global);
1624 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1625 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1626 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1627 unsigned LLVMGetAlignment(LLVMValueRef Global);
1628 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
1631 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1633 * This group contains functions that operate on global variable values.
1635 * @see llvm::GlobalVariable
1639 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1640 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1642 unsigned AddressSpace);
1643 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1644 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1645 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1646 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1647 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1648 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1649 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1650 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1651 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1652 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1653 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1654 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1655 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1656 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1657 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1658 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1665 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1667 * This group contains function that operate on global alias values.
1669 * @see llvm::GlobalAlias
1673 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1681 * @defgroup LLVMCCoreValueFunction Function values
1683 * Functions in this group operate on LLVMValueRef instances that
1684 * correspond to llvm::Function instances.
1686 * @see llvm::Function
1692 * Remove a function from its containing module and deletes it.
1694 * @see llvm::Function::eraseFromParent()
1696 void LLVMDeleteFunction(LLVMValueRef Fn);
1699 * Obtain the ID number from a function instance.
1701 * @see llvm::Function::getIntrinsicID()
1703 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1706 * Obtain the calling function of a function.
1708 * The returned value corresponds to the LLVMCallConv enumeration.
1710 * @see llvm::Function::getCallingConv()
1712 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1715 * Set the calling convention of a function.
1717 * @see llvm::Function::setCallingConv()
1719 * @param Fn Function to operate on
1720 * @param CC LLVMCallConv to set calling convention to
1722 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1725 * Obtain the name of the garbage collector to use during code
1728 * @see llvm::Function::getGC()
1730 const char *LLVMGetGC(LLVMValueRef Fn);
1733 * Define the garbage collector to use during code generation.
1735 * @see llvm::Function::setGC()
1737 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1740 * Add an attribute to a function.
1742 * @see llvm::Function::addAttribute()
1744 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1747 * Add a target-dependent attribute to a fuction
1748 * @see llvm::AttrBuilder::addAttribute()
1750 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1754 * Obtain an attribute from a function.
1756 * @see llvm::Function::getAttributes()
1758 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1761 * Remove an attribute from a function.
1763 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1766 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1768 * Functions in this group relate to arguments/parameters on functions.
1770 * Functions in this group expect LLVMValueRef instances that correspond
1771 * to llvm::Function instances.
1777 * Obtain the number of parameters in a function.
1779 * @see llvm::Function::arg_size()
1781 unsigned LLVMCountParams(LLVMValueRef Fn);
1784 * Obtain the parameters in a function.
1786 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1787 * at least LLVMCountParams() long. This array will be filled with
1788 * LLVMValueRef instances which correspond to the parameters the
1789 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1792 * @see llvm::Function::arg_begin()
1794 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1797 * Obtain the parameter at the specified index.
1799 * Parameters are indexed from 0.
1801 * @see llvm::Function::arg_begin()
1803 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1806 * Obtain the function to which this argument belongs.
1808 * Unlike other functions in this group, this one takes a LLVMValueRef
1809 * that corresponds to a llvm::Attribute.
1811 * The returned LLVMValueRef is the llvm::Function to which this
1814 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1817 * Obtain the first parameter to a function.
1819 * @see llvm::Function::arg_begin()
1821 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1824 * Obtain the last parameter to a function.
1826 * @see llvm::Function::arg_end()
1828 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
1831 * Obtain the next parameter to a function.
1833 * This takes a LLVMValueRef obtained from LLVMGetFirstParam() (which is
1834 * actually a wrapped iterator) and obtains the next parameter from the
1835 * underlying iterator.
1837 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
1840 * Obtain the previous parameter to a function.
1842 * This is the opposite of LLVMGetNextParam().
1844 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
1847 * Add an attribute to a function argument.
1849 * @see llvm::Argument::addAttr()
1851 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1854 * Remove an attribute from a function argument.
1856 * @see llvm::Argument::removeAttr()
1858 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1861 * Get an attribute from a function argument.
1863 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
1866 * Set the alignment for a function parameter.
1868 * @see llvm::Argument::addAttr()
1869 * @see llvm::AttrBuilder::addAlignmentAttr()
1871 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
1890 * @defgroup LLVMCCoreValueMetadata Metadata
1896 * Obtain a MDString value from a context.
1898 * The returned instance corresponds to the llvm::MDString class.
1900 * The instance is specified by string data of a specified length. The
1901 * string content is copied, so the backing memory can be freed after
1902 * this function returns.
1904 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
1908 * Obtain a MDString value from the global context.
1910 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
1913 * Obtain a MDNode value from a context.
1915 * The returned value corresponds to the llvm::MDNode class.
1917 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
1921 * Obtain a MDNode value from the global context.
1923 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
1926 * Obtain the underlying string from a MDString value.
1928 * @param V Instance to obtain string from.
1929 * @param Len Memory address which will hold length of returned string.
1930 * @return String data in MDString.
1932 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
1935 * Obtain the number of operands from an MDNode value.
1937 * @param V MDNode to get number of operands from.
1938 * @return Number of operands of the MDNode.
1940 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
1943 * Obtain the given MDNode's operands.
1945 * The passed LLVMValueRef pointer should point to enough memory to hold all of
1946 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
1947 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
1948 * MDNode's operands.
1950 * @param V MDNode to get the operands from.
1951 * @param Dest Destination array for operands.
1953 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
1960 * @defgroup LLVMCCoreValueBasicBlock Basic Block
1962 * A basic block represents a single entry single exit section of code.
1963 * Basic blocks contain a list of instructions which form the body of
1966 * Basic blocks belong to functions. They have the type of label.
1968 * Basic blocks are themselves values. However, the C API models them as
1969 * LLVMBasicBlockRef.
1971 * @see llvm::BasicBlock
1977 * Convert a basic block instance to a value type.
1979 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
1982 * Determine whether a LLVMValueRef is itself a basic block.
1984 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
1987 * Convert a LLVMValueRef to a LLVMBasicBlockRef instance.
1989 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
1992 * Obtain the function to which a basic block belongs.
1994 * @see llvm::BasicBlock::getParent()
1996 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
1999 * Obtain the terminator instruction for a basic block.
2001 * If the basic block does not have a terminator (it is not well-formed
2002 * if it doesn't), then NULL is returned.
2004 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2006 * @see llvm::BasicBlock::getTerminator()
2008 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2011 * Obtain the number of basic blocks in a function.
2013 * @param Fn Function value to operate on.
2015 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2018 * Obtain all of the basic blocks in a function.
2020 * This operates on a function value. The BasicBlocks parameter is a
2021 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2022 * LLVMCountBasicBlocks() in length. This array is populated with
2023 * LLVMBasicBlockRef instances.
2025 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2028 * Obtain the first basic block in a function.
2030 * The returned basic block can be used as an iterator. You will likely
2031 * eventually call into LLVMGetNextBasicBlock() with it.
2033 * @see llvm::Function::begin()
2035 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2038 * Obtain the last basic block in a function.
2040 * @see llvm::Function::end()
2042 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2045 * Advance a basic block iterator.
2047 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2050 * Go backwards in a basic block iterator.
2052 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2055 * Obtain the basic block that corresponds to the entry point of a
2058 * @see llvm::Function::getEntryBlock()
2060 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2063 * Append a basic block to the end of a function.
2065 * @see llvm::BasicBlock::Create()
2067 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2072 * Append a basic block to the end of a function using the global
2075 * @see llvm::BasicBlock::Create()
2077 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2080 * Insert a basic block in a function before another basic block.
2082 * The function to add to is determined by the function of the
2083 * passed basic block.
2085 * @see llvm::BasicBlock::Create()
2087 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2088 LLVMBasicBlockRef BB,
2092 * Insert a basic block in a function using the global context.
2094 * @see llvm::BasicBlock::Create()
2096 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2100 * Remove a basic block from a function and delete it.
2102 * This deletes the basic block from its containing function and deletes
2103 * the basic block itself.
2105 * @see llvm::BasicBlock::eraseFromParent()
2107 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2110 * Remove a basic block from a function.
2112 * This deletes the basic block from its containing function but keep
2113 * the basic block alive.
2115 * @see llvm::BasicBlock::removeFromParent()
2117 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2120 * Move a basic block to before another one.
2122 * @see llvm::BasicBlock::moveBefore()
2124 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2127 * Move a basic block to after another one.
2129 * @see llvm::BasicBlock::moveAfter()
2131 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2134 * Obtain the first instruction in a basic block.
2136 * The returned LLVMValueRef corresponds to a llvm::Instruction
2139 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2142 * Obtain the last instruction in a basic block.
2144 * The returned LLVMValueRef corresponds to a LLVM:Instruction.
2146 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2153 * @defgroup LLVMCCoreValueInstruction Instructions
2155 * Functions in this group relate to the inspection and manipulation of
2156 * individual instructions.
2158 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2159 * class has a large number of descendents. llvm::Instruction is a
2160 * llvm::Value and in the C API, instructions are modeled by
2163 * This group also contains sub-groups which operate on specific
2164 * llvm::Instruction types, e.g. llvm::CallInst.
2170 * Determine whether an instruction has any metadata attached.
2172 int LLVMHasMetadata(LLVMValueRef Val);
2175 * Return metadata associated with an instruction value.
2177 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2180 * Set metadata associated with an instruction value.
2182 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2185 * Obtain the basic block to which an instruction belongs.
2187 * @see llvm::Instruction::getParent()
2189 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2192 * Obtain the instruction that occurs after the one specified.
2194 * The next instruction will be from the same basic block.
2196 * If this is the last instruction in a basic block, NULL will be
2199 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2202 * Obtain the instruction that occurred before this one.
2204 * If the instruction is the first instruction in a basic block, NULL
2207 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2210 * Remove and delete an instruction.
2212 * The instruction specified is removed from its containing building
2213 * block and then deleted.
2215 * @see llvm::Instruction::eraseFromParent()
2217 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2220 * Obtain the code opcode for an individual instruction.
2222 * @see llvm::Instruction::getOpCode()
2224 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2227 * Obtain the predicate of an instruction.
2229 * This is only valid for instructions that correspond to llvm::ICmpInst
2230 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2232 * @see llvm::ICmpInst::getPredicate()
2234 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2237 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2239 * Functions in this group apply to instructions that refer to call
2240 * sites and invocations. These correspond to C++ types in the
2241 * llvm::CallInst class tree.
2247 * Set the calling convention for a call instruction.
2249 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2252 * @see llvm::CallInst::setCallingConv()
2253 * @see llvm::InvokeInst::setCallingConv()
2255 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2258 * Obtain the calling convention for a call instruction.
2260 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2263 * @see LLVMSetInstructionCallConv()
2265 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2268 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2269 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2271 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2275 * Obtain whether a call instruction is a tail call.
2277 * This only works on llvm::CallInst instructions.
2279 * @see llvm::CallInst::isTailCall()
2281 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2284 * Set whether a call instruction is a tail call.
2286 * This only works on llvm::CallInst instructions.
2288 * @see llvm::CallInst::setTailCall()
2290 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2297 * Obtain the default destination basic block of a switch instruction.
2299 * This only works on llvm::SwitchInst instructions.
2301 * @see llvm::SwitchInst::getDefaultDest()
2303 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2306 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2308 * Functions in this group only apply to instructions that map to
2309 * llvm::PHINode instances.
2315 * Add an incoming value to the end of a PHI list.
2317 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2318 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2321 * Obtain the number of incoming basic blocks to a PHI node.
2323 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2326 * Obtain an incoming value to a PHI node as a LLVMValueRef.
2328 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2331 * Obtain an incoming value to a PHI node as a LLVMBasicBlockRef.
2333 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2348 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2350 * An instruction builder represents a point within a basic block and is
2351 * the exclusive means of building instructions using the C interface.
2356 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2357 LLVMBuilderRef LLVMCreateBuilder(void);
2358 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2359 LLVMValueRef Instr);
2360 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2361 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2362 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2363 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2364 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2365 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2367 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2370 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2371 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2372 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2375 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2376 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2377 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2379 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2380 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2381 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2382 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2383 LLVMBasicBlockRef Else, unsigned NumCases);
2384 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2386 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2387 LLVMValueRef *Args, unsigned NumArgs,
2388 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2390 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2391 LLVMValueRef PersFn, unsigned NumClauses,
2393 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2394 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2396 /* Add a case to the switch instruction */
2397 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2398 LLVMBasicBlockRef Dest);
2400 /* Add a destination to the indirectbr instruction */
2401 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2403 /* Add a catch or filter clause to the landingpad instruction */
2404 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2406 /* Set the 'cleanup' flag in the landingpad instruction */
2407 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2410 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2412 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2414 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2416 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2418 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2420 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2422 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2424 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2426 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2428 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2430 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2432 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2434 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2436 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2438 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2440 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2442 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2444 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2446 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2448 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2450 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2452 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2454 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2456 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2458 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2460 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2461 LLVMValueRef LHS, LLVMValueRef RHS,
2463 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2464 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2466 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2468 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2469 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2472 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2473 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2474 LLVMValueRef Val, const char *Name);
2475 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2476 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2477 LLVMValueRef Val, const char *Name);
2478 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2479 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2481 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2482 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2483 LLVMValueRef *Indices, unsigned NumIndices,
2485 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2486 LLVMValueRef *Indices, unsigned NumIndices,
2488 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2489 unsigned Idx, const char *Name);
2490 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2492 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2494 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2495 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2498 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2499 LLVMTypeRef DestTy, const char *Name);
2500 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2501 LLVMTypeRef DestTy, const char *Name);
2502 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2503 LLVMTypeRef DestTy, const char *Name);
2504 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2505 LLVMTypeRef DestTy, const char *Name);
2506 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2507 LLVMTypeRef DestTy, const char *Name);
2508 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2509 LLVMTypeRef DestTy, const char *Name);
2510 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2511 LLVMTypeRef DestTy, const char *Name);
2512 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2513 LLVMTypeRef DestTy, const char *Name);
2514 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2515 LLVMTypeRef DestTy, const char *Name);
2516 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2517 LLVMTypeRef DestTy, const char *Name);
2518 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2519 LLVMTypeRef DestTy, const char *Name);
2520 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2521 LLVMTypeRef DestTy, const char *Name);
2522 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2523 LLVMTypeRef DestTy, const char *Name);
2524 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2525 LLVMTypeRef DestTy, const char *Name);
2526 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2527 LLVMTypeRef DestTy, const char *Name);
2528 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2529 LLVMTypeRef DestTy, const char *Name);
2530 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2531 LLVMTypeRef DestTy, const char *Name);
2532 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2533 LLVMTypeRef DestTy, const char *Name);
2534 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2535 LLVMTypeRef DestTy, const char *Name);
2538 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2539 LLVMValueRef LHS, LLVMValueRef RHS,
2541 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2542 LLVMValueRef LHS, LLVMValueRef RHS,
2545 /* Miscellaneous instructions */
2546 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2547 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2548 LLVMValueRef *Args, unsigned NumArgs,
2550 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2551 LLVMValueRef Then, LLVMValueRef Else,
2553 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2555 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2556 LLVMValueRef Index, const char *Name);
2557 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2558 LLVMValueRef EltVal, LLVMValueRef Index,
2560 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2561 LLVMValueRef V2, LLVMValueRef Mask,
2563 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2564 unsigned Index, const char *Name);
2565 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2566 LLVMValueRef EltVal, unsigned Index,
2569 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2571 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2573 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2574 LLVMValueRef RHS, const char *Name);
2575 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B,LLVMAtomicRMWBinOp op,
2576 LLVMValueRef PTR, LLVMValueRef Val,
2577 LLVMAtomicOrdering ordering,
2578 LLVMBool singleThread);
2585 * @defgroup LLVMCCoreModuleProvider Module Providers
2591 * Changes the type of M so it can be passed to FunctionPassManagers and the
2592 * JIT. They take ModuleProviders for historical reasons.
2594 LLVMModuleProviderRef
2595 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2598 * Destroys the module M.
2600 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2607 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2612 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2613 LLVMMemoryBufferRef *OutMemBuf,
2615 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2617 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2618 size_t InputDataLength,
2619 const char *BufferName,
2620 LLVMBool RequiresNullTerminator);
2621 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2622 size_t InputDataLength,
2623 const char *BufferName);
2624 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2625 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2626 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2633 * @defgroup LLVMCCorePassRegistry Pass Registry
2638 /** Return the global pass registry, for use with initialization functions.
2639 @see llvm::PassRegistry::getPassRegistry */
2640 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2647 * @defgroup LLVMCCorePassManagers Pass Managers
2652 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2653 suitable for link-time optimization and whole-module transformations.
2654 @see llvm::PassManager::PassManager */
2655 LLVMPassManagerRef LLVMCreatePassManager(void);
2657 /** Constructs a new function-by-function pass pipeline over the module
2658 provider. It does not take ownership of the module provider. This type of
2659 pipeline is suitable for code generation and JIT compilation tasks.
2660 @see llvm::FunctionPassManager::FunctionPassManager */
2661 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2663 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2664 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2666 /** Initializes, executes on the provided module, and finalizes all of the
2667 passes scheduled in the pass manager. Returns 1 if any of the passes
2668 modified the module, 0 otherwise.
2669 @see llvm::PassManager::run(Module&) */
2670 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2672 /** Initializes all of the function passes scheduled in the function pass
2673 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2674 @see llvm::FunctionPassManager::doInitialization */
2675 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2677 /** Executes all of the function passes scheduled in the function pass manager
2678 on the provided function. Returns 1 if any of the passes modified the
2679 function, false otherwise.
2680 @see llvm::FunctionPassManager::run(Function&) */
2681 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2683 /** Finalizes all of the function passes scheduled in in the function pass
2684 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2685 @see llvm::FunctionPassManager::doFinalization */
2686 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2688 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2689 the module provider.
2690 @see llvm::PassManagerBase::~PassManagerBase. */
2691 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2698 * @defgroup LLVMCCoreThreading Threading
2700 * Handle the structures needed to make LLVM safe for multithreading.
2705 /** Allocate and initialize structures needed to make LLVM safe for
2706 multithreading. The return value indicates whether multithreaded
2707 initialization succeeded. Must be executed in isolation from all
2708 other LLVM api calls.
2709 @see llvm::llvm_start_multithreaded */
2710 LLVMBool LLVMStartMultithreaded();
2712 /** Deallocate structures necessary to make LLVM safe for multithreading.
2713 Must be executed in isolation from all other LLVM api calls.
2714 @see llvm::llvm_stop_multithreaded */
2715 void LLVMStopMultithreaded();
2717 /** Check whether LLVM is executing in thread-safe mode or not.
2718 @see llvm::llvm_is_multithreaded */
2719 LLVMBool LLVMIsMultithreaded();
2735 #endif /* !defined(__cplusplus) */
2737 #endif /* !defined(LLVM_C_CORE_H) */