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,
171 LLVMInAllocaAttribute = 1ULL << 36
176 /* Terminator Instructions */
182 /* removed 6 due to API changes */
185 /* Standard Binary Operators */
199 /* Logical Operators */
207 /* Memory Operators */
211 LLVMGetElementPtr = 29,
226 LLVMAddrSpaceCast = 60,
228 /* Other Operators */
237 LLVMExtractElement = 50,
238 LLVMInsertElement = 51,
239 LLVMShuffleVector = 52,
240 LLVMExtractValue = 53,
241 LLVMInsertValue = 54,
243 /* Atomic operators */
245 LLVMAtomicCmpXchg = 56,
248 /* Exception Handling Operators */
255 LLVMVoidTypeKind, /**< type with no size */
256 LLVMHalfTypeKind, /**< 16 bit floating point type */
257 LLVMFloatTypeKind, /**< 32 bit floating point type */
258 LLVMDoubleTypeKind, /**< 64 bit floating point type */
259 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
260 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
261 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
262 LLVMLabelTypeKind, /**< Labels */
263 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
264 LLVMFunctionTypeKind, /**< Functions */
265 LLVMStructTypeKind, /**< Structures */
266 LLVMArrayTypeKind, /**< Arrays */
267 LLVMPointerTypeKind, /**< Pointers */
268 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
269 LLVMMetadataTypeKind, /**< Metadata */
270 LLVMX86_MMXTypeKind /**< X86 MMX */
274 LLVMExternalLinkage, /**< Externally visible function */
275 LLVMAvailableExternallyLinkage,
276 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
277 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
279 LLVMLinkOnceODRAutoHideLinkage, /**< Obsolete */
280 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
281 LLVMWeakODRLinkage, /**< Same, but only replaced by something
283 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
284 LLVMInternalLinkage, /**< Rename collisions when linking (static
286 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
287 LLVMDLLImportLinkage, /**< Obsolete */
288 LLVMDLLExportLinkage, /**< Obsolete */
289 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
290 LLVMGhostLinkage, /**< Obsolete */
291 LLVMCommonLinkage, /**< Tentative definitions */
292 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
293 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
297 LLVMDefaultVisibility, /**< The GV is visible */
298 LLVMHiddenVisibility, /**< The GV is hidden */
299 LLVMProtectedVisibility /**< The GV is protected */
303 LLVMDefaultStorageClass = 0,
304 LLVMDLLImportStorageClass = 1, /**< Function to be imported from DLL. */
305 LLVMDLLExportStorageClass = 2 /**< Function to be accessible from DLL. */
306 } LLVMDLLStorageClass;
310 LLVMFastCallConv = 8,
311 LLVMColdCallConv = 9,
312 LLVMWebKitJSCallConv = 12,
313 LLVMAnyRegCallConv = 13,
314 LLVMX86StdcallCallConv = 64,
315 LLVMX86FastcallCallConv = 65
319 LLVMIntEQ = 32, /**< equal */
320 LLVMIntNE, /**< not equal */
321 LLVMIntUGT, /**< unsigned greater than */
322 LLVMIntUGE, /**< unsigned greater or equal */
323 LLVMIntULT, /**< unsigned less than */
324 LLVMIntULE, /**< unsigned less or equal */
325 LLVMIntSGT, /**< signed greater than */
326 LLVMIntSGE, /**< signed greater or equal */
327 LLVMIntSLT, /**< signed less than */
328 LLVMIntSLE /**< signed less or equal */
332 LLVMRealPredicateFalse, /**< Always false (always folded) */
333 LLVMRealOEQ, /**< True if ordered and equal */
334 LLVMRealOGT, /**< True if ordered and greater than */
335 LLVMRealOGE, /**< True if ordered and greater than or equal */
336 LLVMRealOLT, /**< True if ordered and less than */
337 LLVMRealOLE, /**< True if ordered and less than or equal */
338 LLVMRealONE, /**< True if ordered and operands are unequal */
339 LLVMRealORD, /**< True if ordered (no nans) */
340 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
341 LLVMRealUEQ, /**< True if unordered or equal */
342 LLVMRealUGT, /**< True if unordered or greater than */
343 LLVMRealUGE, /**< True if unordered, greater than, or equal */
344 LLVMRealULT, /**< True if unordered or less than */
345 LLVMRealULE, /**< True if unordered, less than, or equal */
346 LLVMRealUNE, /**< True if unordered or not equal */
347 LLVMRealPredicateTrue /**< Always true (always folded) */
351 LLVMLandingPadCatch, /**< A catch clause */
352 LLVMLandingPadFilter /**< A filter clause */
353 } LLVMLandingPadClauseTy;
356 LLVMNotThreadLocal = 0,
357 LLVMGeneralDynamicTLSModel,
358 LLVMLocalDynamicTLSModel,
359 LLVMInitialExecTLSModel,
360 LLVMLocalExecTLSModel
361 } LLVMThreadLocalMode;
364 LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */
365 LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees
366 somewhat sane results, lock free. */
367 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the
368 operations affecting a specific address,
369 a consistent ordering exists */
370 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort
371 necessary to acquire a lock to access other
372 memory with normal loads and stores. */
373 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with
374 a barrier of the sort necessary to release
376 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
377 Release barrier (for fences and
378 operations which both read and write
380 LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics
381 for loads and Release
382 semantics for stores.
383 Additionally, it guarantees
384 that a total ordering exists
386 SequentiallyConsistent
388 } LLVMAtomicOrdering;
391 LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */
392 LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */
393 LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */
394 LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */
395 LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */
396 LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */
397 LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */
398 LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the
399 original using a signed comparison and return
401 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
402 original using a signed comparison and return
404 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
405 original using an unsigned comparison and return
407 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
408 original using an unsigned comparison and return
410 } LLVMAtomicRMWBinOp;
416 void LLVMInitializeCore(LLVMPassRegistryRef R);
418 /** Deallocate and destroy all ManagedStatic variables.
419 @see llvm::llvm_shutdown
420 @see ManagedStatic */
421 void LLVMShutdown(void);
424 /*===-- Error handling ----------------------------------------------------===*/
426 char *LLVMCreateMessage(const char *Message);
427 void LLVMDisposeMessage(char *Message);
429 typedef void (*LLVMFatalErrorHandler)(const char *Reason);
432 * Install a fatal error handler. By default, if LLVM detects a fatal error, it
433 * will call exit(1). This may not be appropriate in many contexts. For example,
434 * doing exit(1) will bypass many crash reporting/tracing system tools. This
435 * function allows you to install a callback that will be invoked prior to the
438 void LLVMInstallFatalErrorHandler(LLVMFatalErrorHandler Handler);
441 * Reset the fatal error handler. This resets LLVM's fatal error handling
442 * behavior to the default.
444 void LLVMResetFatalErrorHandler(void);
447 * Enable LLVM's built-in stack trace code. This intercepts the OS's crash
448 * signals and prints which component of LLVM you were in at the time if the
451 void LLVMEnablePrettyStackTrace(void);
454 * @defgroup LLVMCCoreContext Contexts
456 * Contexts are execution states for the core LLVM IR system.
458 * Most types are tied to a context instance. Multiple contexts can
459 * exist simultaneously. A single context is not thread safe. However,
460 * different contexts can execute on different threads simultaneously.
466 * Create a new context.
468 * Every call to this function should be paired with a call to
469 * LLVMContextDispose() or the context will leak memory.
471 LLVMContextRef LLVMContextCreate(void);
474 * Obtain the global context instance.
476 LLVMContextRef LLVMGetGlobalContext(void);
479 * Destroy a context instance.
481 * This should be called for every call to LLVMContextCreate() or memory
484 void LLVMContextDispose(LLVMContextRef C);
486 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
488 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
495 * @defgroup LLVMCCoreModule Modules
497 * Modules represent the top-level structure in an LLVM program. An LLVM
498 * module is effectively a translation unit or a collection of
499 * translation units merged together.
505 * Create a new, empty module in the global context.
507 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
508 * LLVMGetGlobalContext() as the context parameter.
510 * Every invocation should be paired with LLVMDisposeModule() or memory
513 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
516 * Create a new, empty module in a specific context.
518 * Every invocation should be paired with LLVMDisposeModule() or memory
521 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
525 * Destroy a module instance.
527 * This must be called for every created module or memory will be
530 void LLVMDisposeModule(LLVMModuleRef M);
533 * Obtain the data layout for a module.
535 * @see Module::getDataLayout()
537 const char *LLVMGetDataLayout(LLVMModuleRef M);
540 * Set the data layout for a module.
542 * @see Module::setDataLayout()
544 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
547 * Obtain the target triple for a module.
549 * @see Module::getTargetTriple()
551 const char *LLVMGetTarget(LLVMModuleRef M);
554 * Set the target triple for a module.
556 * @see Module::setTargetTriple()
558 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
561 * Dump a representation of a module to stderr.
563 * @see Module::dump()
565 void LLVMDumpModule(LLVMModuleRef M);
568 * Print a representation of a module to a file. The ErrorMessage needs to be
569 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
571 * @see Module::print()
573 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
574 char **ErrorMessage);
577 * Return a string representation of the module. Use
578 * LLVMDisposeMessage to free the string.
580 * @see Module::print()
582 char *LLVMPrintModuleToString(LLVMModuleRef M);
585 * Set inline assembly for a module.
587 * @see Module::setModuleInlineAsm()
589 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
592 * Obtain the context to which this module is associated.
594 * @see Module::getContext()
596 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
599 * Obtain a Type from a module by its registered name.
601 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
604 * Obtain the number of operands for named metadata in a module.
606 * @see llvm::Module::getNamedMetadata()
608 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
611 * Obtain the named metadata operands for a module.
613 * The passed LLVMValueRef pointer should refer to an array of
614 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
615 * array will be populated with the LLVMValueRef instances. Each
616 * instance corresponds to a llvm::MDNode.
618 * @see llvm::Module::getNamedMetadata()
619 * @see llvm::MDNode::getOperand()
621 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
624 * Add an operand to named metadata.
626 * @see llvm::Module::getNamedMetadata()
627 * @see llvm::MDNode::addOperand()
629 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
633 * Add a function to a module under a specified name.
635 * @see llvm::Function::Create()
637 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
638 LLVMTypeRef FunctionTy);
641 * Obtain a Function value from a Module by its name.
643 * The returned value corresponds to a llvm::Function value.
645 * @see llvm::Module::getFunction()
647 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
650 * Obtain an iterator to the first Function in a Module.
652 * @see llvm::Module::begin()
654 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
657 * Obtain an iterator to the last Function in a Module.
659 * @see llvm::Module::end()
661 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
664 * Advance a Function iterator to the next Function.
666 * Returns NULL if the iterator was already at the end and there are no more
669 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
672 * Decrement a Function iterator to the previous Function.
674 * Returns NULL if the iterator was already at the beginning and there are
675 * no previous functions.
677 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
684 * @defgroup LLVMCCoreType Types
686 * Types represent the type of a value.
688 * Types are associated with a context instance. The context internally
689 * deduplicates types so there is only 1 instance of a specific type
690 * alive at a time. In other words, a unique type is shared among all
691 * consumers within a context.
693 * A Type in the C API corresponds to llvm::Type.
695 * Types have the following hierarchy:
713 * Obtain the enumerated type of a Type instance.
715 * @see llvm::Type:getTypeID()
717 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
720 * Whether the type has a known size.
722 * Things that don't have a size are abstract types, labels, and void.a
724 * @see llvm::Type::isSized()
726 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
729 * Obtain the context to which this type instance is associated.
731 * @see llvm::Type::getContext()
733 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
736 * Dump a representation of a type to stderr.
738 * @see llvm::Type::dump()
740 void LLVMDumpType(LLVMTypeRef Val);
743 * Return a string representation of the type. Use
744 * LLVMDisposeMessage to free the string.
746 * @see llvm::Type::print()
748 char *LLVMPrintTypeToString(LLVMTypeRef Val);
751 * @defgroup LLVMCCoreTypeInt Integer Types
753 * Functions in this section operate on integer types.
759 * Obtain an integer type from a context with specified bit width.
761 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
762 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
763 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
764 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
765 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
766 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
769 * Obtain an integer type from the global context with a specified bit
772 LLVMTypeRef LLVMInt1Type(void);
773 LLVMTypeRef LLVMInt8Type(void);
774 LLVMTypeRef LLVMInt16Type(void);
775 LLVMTypeRef LLVMInt32Type(void);
776 LLVMTypeRef LLVMInt64Type(void);
777 LLVMTypeRef LLVMIntType(unsigned NumBits);
778 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
785 * @defgroup LLVMCCoreTypeFloat Floating Point Types
791 * Obtain a 16-bit floating point type from a context.
793 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
796 * Obtain a 32-bit floating point type from a context.
798 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
801 * Obtain a 64-bit floating point type from a context.
803 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
806 * Obtain a 80-bit floating point type (X87) from a context.
808 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
811 * Obtain a 128-bit floating point type (112-bit mantissa) from a
814 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
817 * Obtain a 128-bit floating point type (two 64-bits) from a context.
819 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
822 * Obtain a floating point type from the global context.
824 * These map to the functions in this group of the same name.
826 LLVMTypeRef LLVMHalfType(void);
827 LLVMTypeRef LLVMFloatType(void);
828 LLVMTypeRef LLVMDoubleType(void);
829 LLVMTypeRef LLVMX86FP80Type(void);
830 LLVMTypeRef LLVMFP128Type(void);
831 LLVMTypeRef LLVMPPCFP128Type(void);
838 * @defgroup LLVMCCoreTypeFunction Function Types
844 * Obtain a function type consisting of a specified signature.
846 * The function is defined as a tuple of a return Type, a list of
847 * parameter types, and whether the function is variadic.
849 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
850 LLVMTypeRef *ParamTypes, unsigned ParamCount,
854 * Returns whether a function type is variadic.
856 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
859 * Obtain the Type this function Type returns.
861 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
864 * Obtain the number of parameters this function accepts.
866 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
869 * Obtain the types of a function's parameters.
871 * The Dest parameter should point to a pre-allocated array of
872 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
873 * first LLVMCountParamTypes() entries in the array will be populated
874 * with LLVMTypeRef instances.
876 * @param FunctionTy The function type to operate on.
877 * @param Dest Memory address of an array to be filled with result.
879 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
886 * @defgroup LLVMCCoreTypeStruct Structure Types
888 * These functions relate to LLVMTypeRef instances.
890 * @see llvm::StructType
896 * Create a new structure type in a context.
898 * A structure is specified by a list of inner elements/types and
899 * whether these can be packed together.
901 * @see llvm::StructType::create()
903 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
904 unsigned ElementCount, LLVMBool Packed);
907 * Create a new structure type in the global context.
909 * @see llvm::StructType::create()
911 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
915 * Create an empty structure in a context having a specified name.
917 * @see llvm::StructType::create()
919 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
922 * Obtain the name of a structure.
924 * @see llvm::StructType::getName()
926 const char *LLVMGetStructName(LLVMTypeRef Ty);
929 * Set the contents of a structure type.
931 * @see llvm::StructType::setBody()
933 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
934 unsigned ElementCount, LLVMBool Packed);
937 * Get the number of elements defined inside the structure.
939 * @see llvm::StructType::getNumElements()
941 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
944 * Get the elements within a structure.
946 * The function is passed the address of a pre-allocated array of
947 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
948 * invocation, this array will be populated with the structure's
949 * elements. The objects in the destination array will have a lifetime
950 * of the structure type itself, which is the lifetime of the context it
953 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
956 * Determine whether a structure is packed.
958 * @see llvm::StructType::isPacked()
960 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
963 * Determine whether a structure is opaque.
965 * @see llvm::StructType::isOpaque()
967 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
975 * @defgroup LLVMCCoreTypeSequential Sequential Types
977 * Sequential types represents "arrays" of types. This is a super class
978 * for array, vector, and pointer types.
984 * Obtain the type of elements within a sequential type.
986 * This works on array, vector, and pointer types.
988 * @see llvm::SequentialType::getElementType()
990 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
993 * Create a fixed size array type that refers to a specific type.
995 * The created type will exist in the context that its element type
998 * @see llvm::ArrayType::get()
1000 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
1003 * Obtain the length of an array type.
1005 * This only works on types that represent arrays.
1007 * @see llvm::ArrayType::getNumElements()
1009 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
1012 * Create a pointer type that points to a defined type.
1014 * The created type will exist in the context that its pointee type
1017 * @see llvm::PointerType::get()
1019 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
1022 * Obtain the address space of a pointer type.
1024 * This only works on types that represent pointers.
1026 * @see llvm::PointerType::getAddressSpace()
1028 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
1031 * Create a vector type that contains a defined type and has a specific
1032 * number of elements.
1034 * The created type will exist in the context thats its element type
1037 * @see llvm::VectorType::get()
1039 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
1042 * Obtain the number of elements in a vector type.
1044 * This only works on types that represent vectors.
1046 * @see llvm::VectorType::getNumElements()
1048 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1055 * @defgroup LLVMCCoreTypeOther Other Types
1061 * Create a void type in a context.
1063 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1066 * Create a label type in a context.
1068 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1071 * Create a X86 MMX type in a context.
1073 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1076 * These are similar to the above functions except they operate on the
1079 LLVMTypeRef LLVMVoidType(void);
1080 LLVMTypeRef LLVMLabelType(void);
1081 LLVMTypeRef LLVMX86MMXType(void);
1092 * @defgroup LLVMCCoreValues Values
1094 * The bulk of LLVM's object model consists of values, which comprise a very
1095 * rich type hierarchy.
1097 * LLVMValueRef essentially represents llvm::Value. There is a rich
1098 * hierarchy of classes within this type. Depending on the instance
1099 * obtained, not all APIs are available.
1101 * Callers can determine the type of an LLVMValueRef by calling the
1102 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1103 * functions are defined by a macro, so it isn't obvious which are
1104 * available by looking at the Doxygen source code. Instead, look at the
1105 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1106 * of value names given. These value names also correspond to classes in
1107 * the llvm::Value hierarchy.
1112 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1120 macro(BlockAddress) \
1121 macro(ConstantAggregateZero) \
1122 macro(ConstantArray) \
1123 macro(ConstantDataSequential) \
1124 macro(ConstantDataArray) \
1125 macro(ConstantDataVector) \
1126 macro(ConstantExpr) \
1128 macro(ConstantInt) \
1129 macro(ConstantPointerNull) \
1130 macro(ConstantStruct) \
1131 macro(ConstantVector) \
1132 macro(GlobalValue) \
1134 macro(GlobalAlias) \
1135 macro(GlobalVariable) \
1137 macro(Instruction) \
1138 macro(BinaryOperator) \
1140 macro(IntrinsicInst) \
1141 macro(DbgInfoIntrinsic) \
1142 macro(DbgDeclareInst) \
1143 macro(MemIntrinsic) \
1145 macro(MemMoveInst) \
1150 macro(ExtractElementInst) \
1151 macro(GetElementPtrInst) \
1152 macro(InsertElementInst) \
1153 macro(InsertValueInst) \
1154 macro(LandingPadInst) \
1157 macro(ShuffleVectorInst) \
1159 macro(TerminatorInst) \
1161 macro(IndirectBrInst) \
1165 macro(UnreachableInst) \
1167 macro(UnaryInstruction) \
1170 macro(AddrSpaceCastInst) \
1171 macro(BitCastInst) \
1175 macro(FPTruncInst) \
1176 macro(IntToPtrInst) \
1177 macro(PtrToIntInst) \
1183 macro(ExtractValueInst) \
1188 * @defgroup LLVMCCoreValueGeneral General APIs
1190 * Functions in this section work on all LLVMValueRef instances,
1191 * regardless of their sub-type. They correspond to functions available
1198 * Obtain the type of a value.
1200 * @see llvm::Value::getType()
1202 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1205 * Obtain the string name of a value.
1207 * @see llvm::Value::getName()
1209 const char *LLVMGetValueName(LLVMValueRef Val);
1212 * Set the string name of a value.
1214 * @see llvm::Value::setName()
1216 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1219 * Dump a representation of a value to stderr.
1221 * @see llvm::Value::dump()
1223 void LLVMDumpValue(LLVMValueRef Val);
1226 * Return a string representation of the value. Use
1227 * LLVMDisposeMessage to free the string.
1229 * @see llvm::Value::print()
1231 char *LLVMPrintValueToString(LLVMValueRef Val);
1234 * Replace all uses of a value with another one.
1236 * @see llvm::Value::replaceAllUsesWith()
1238 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1241 * Determine whether the specified constant instance is constant.
1243 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1246 * Determine whether a value instance is undefined.
1248 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1251 * Convert value instances between types.
1253 * Internally, an LLVMValueRef is "pinned" to a specific type. This
1254 * series of functions allows you to cast an instance to a specific
1257 * If the cast is not valid for the specified type, NULL is returned.
1259 * @see llvm::dyn_cast_or_null<>
1261 #define LLVM_DECLARE_VALUE_CAST(name) \
1262 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1263 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1270 * @defgroup LLVMCCoreValueUses Usage
1272 * This module defines functions that allow you to inspect the uses of a
1275 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1276 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1277 * llvm::User and llvm::Value.
1283 * Obtain the first use of a value.
1285 * Uses are obtained in an iterator fashion. First, call this function
1286 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1287 * on that instance and all subsequently obtained instances until
1288 * LLVMGetNextUse() returns NULL.
1290 * @see llvm::Value::use_begin()
1292 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1295 * Obtain the next use of a value.
1297 * This effectively advances the iterator. It returns NULL if you are on
1298 * the final use and no more are available.
1300 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1303 * Obtain the user value for a user.
1305 * The returned value corresponds to a llvm::User type.
1307 * @see llvm::Use::getUser()
1309 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1312 * Obtain the value this use corresponds to.
1314 * @see llvm::Use::get().
1316 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1323 * @defgroup LLVMCCoreValueUser User value
1325 * Function in this group pertain to LLVMValueRef instances that descent
1326 * from llvm::User. This includes constants, instructions, and
1333 * Obtain an operand at a specific index in a llvm::User value.
1335 * @see llvm::User::getOperand()
1337 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1340 * Set an operand at a specific index in a llvm::User value.
1342 * @see llvm::User::setOperand()
1344 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1347 * Obtain the number of operands in a llvm::User value.
1349 * @see llvm::User::getNumOperands()
1351 int LLVMGetNumOperands(LLVMValueRef Val);
1358 * @defgroup LLVMCCoreValueConstant Constants
1360 * This section contains APIs for interacting with LLVMValueRef that
1361 * correspond to llvm::Constant instances.
1363 * These functions will work for any LLVMValueRef in the llvm::Constant
1370 * Obtain a constant value referring to the null instance of a type.
1372 * @see llvm::Constant::getNullValue()
1374 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1377 * Obtain a constant value referring to the instance of a type
1378 * consisting of all ones.
1380 * This is only valid for integer types.
1382 * @see llvm::Constant::getAllOnesValue()
1384 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1387 * Obtain a constant value referring to an undefined value of a type.
1389 * @see llvm::UndefValue::get()
1391 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1394 * Determine whether a value instance is null.
1396 * @see llvm::Constant::isNullValue()
1398 LLVMBool LLVMIsNull(LLVMValueRef Val);
1401 * Obtain a constant that is a constant pointer pointing to NULL for a
1404 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1407 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1409 * Functions in this group model LLVMValueRef instances that correspond
1410 * to constants referring to scalar types.
1412 * For integer types, the LLVMTypeRef parameter should correspond to a
1413 * llvm::IntegerType instance and the returned LLVMValueRef will
1414 * correspond to a llvm::ConstantInt.
1416 * For floating point types, the LLVMTypeRef returned corresponds to a
1423 * Obtain a constant value for an integer type.
1425 * The returned value corresponds to a llvm::ConstantInt.
1427 * @see llvm::ConstantInt::get()
1429 * @param IntTy Integer type to obtain value of.
1430 * @param N The value the returned instance should refer to.
1431 * @param SignExtend Whether to sign extend the produced value.
1433 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1434 LLVMBool SignExtend);
1437 * Obtain a constant value for an integer of arbitrary precision.
1439 * @see llvm::ConstantInt::get()
1441 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1443 const uint64_t Words[]);
1446 * Obtain a constant value for an integer parsed from a string.
1448 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1449 * string's length is available, it is preferred to call that function
1452 * @see llvm::ConstantInt::get()
1454 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1458 * Obtain a constant value for an integer parsed from a string with
1461 * @see llvm::ConstantInt::get()
1463 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1464 unsigned SLen, uint8_t Radix);
1467 * Obtain a constant value referring to a double floating point value.
1469 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1472 * Obtain a constant for a floating point value parsed from a string.
1474 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1475 * should be used if the input string's length is known.
1477 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1480 * Obtain a constant for a floating point value parsed from a string.
1482 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1486 * Obtain the zero extended value for an integer constant value.
1488 * @see llvm::ConstantInt::getZExtValue()
1490 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1493 * Obtain the sign extended value for an integer constant value.
1495 * @see llvm::ConstantInt::getSExtValue()
1497 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1504 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1506 * Functions in this group operate on composite constants.
1512 * Create a ConstantDataSequential and initialize it with a string.
1514 * @see llvm::ConstantDataArray::getString()
1516 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1517 unsigned Length, LLVMBool DontNullTerminate);
1520 * Create a ConstantDataSequential with string content in the global context.
1522 * This is the same as LLVMConstStringInContext except it operates on the
1525 * @see LLVMConstStringInContext()
1526 * @see llvm::ConstantDataArray::getString()
1528 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1529 LLVMBool DontNullTerminate);
1532 * Create an anonymous ConstantStruct with the specified values.
1534 * @see llvm::ConstantStruct::getAnon()
1536 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1537 LLVMValueRef *ConstantVals,
1538 unsigned Count, LLVMBool Packed);
1541 * Create a ConstantStruct in the global Context.
1543 * This is the same as LLVMConstStructInContext except it operates on the
1546 * @see LLVMConstStructInContext()
1548 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1552 * Create a ConstantArray from values.
1554 * @see llvm::ConstantArray::get()
1556 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1557 LLVMValueRef *ConstantVals, unsigned Length);
1560 * Create a non-anonymous ConstantStruct from values.
1562 * @see llvm::ConstantStruct::get()
1564 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1565 LLVMValueRef *ConstantVals,
1569 * Create a ConstantVector from values.
1571 * @see llvm::ConstantVector::get()
1573 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1580 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1582 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1584 * @see llvm::ConstantExpr.
1588 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1589 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1590 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1591 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1592 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1593 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1594 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1595 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1596 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1597 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1598 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1599 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1600 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1601 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1602 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1603 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1604 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1605 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1606 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1607 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1608 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1609 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1610 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1611 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1612 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1613 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1614 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1615 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1616 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1617 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1618 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1619 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1620 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1621 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1622 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1623 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1624 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1625 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1626 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1627 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1628 LLVMValueRef *ConstantIndices,
1629 unsigned NumIndices);
1630 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1631 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1632 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1633 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1634 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1635 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1636 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1637 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1638 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1639 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1640 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1641 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1642 LLVMValueRef LLVMConstAddrSpaceCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1643 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1644 LLVMTypeRef ToType);
1645 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1646 LLVMTypeRef ToType);
1647 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1648 LLVMTypeRef ToType);
1649 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1650 LLVMTypeRef ToType);
1651 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1653 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1654 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1655 LLVMValueRef ConstantIfTrue,
1656 LLVMValueRef ConstantIfFalse);
1657 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1658 LLVMValueRef IndexConstant);
1659 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1660 LLVMValueRef ElementValueConstant,
1661 LLVMValueRef IndexConstant);
1662 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1663 LLVMValueRef VectorBConstant,
1664 LLVMValueRef MaskConstant);
1665 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1667 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1668 LLVMValueRef ElementValueConstant,
1669 unsigned *IdxList, unsigned NumIdx);
1670 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1671 const char *AsmString, const char *Constraints,
1672 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1673 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1680 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1682 * This group contains functions that operate on global values. Functions in
1683 * this group relate to functions in the llvm::GlobalValue class tree.
1685 * @see llvm::GlobalValue
1690 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1691 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1692 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1693 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1694 const char *LLVMGetSection(LLVMValueRef Global);
1695 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1696 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1697 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1698 LLVMDLLStorageClass LLVMGetDLLStorageClass(LLVMValueRef Global);
1699 void LLVMSetDLLStorageClass(LLVMValueRef Global, LLVMDLLStorageClass Class);
1702 * @defgroup LLVMCCoreValueWithAlignment Values with alignment
1704 * Functions in this group only apply to values with alignment, i.e.
1705 * global variables, load and store instructions.
1709 * Obtain the preferred alignment of the value.
1710 * @see llvm::LoadInst::getAlignment()
1711 * @see llvm::StoreInst::getAlignment()
1712 * @see llvm::GlobalValue::getAlignment()
1714 unsigned LLVMGetAlignment(LLVMValueRef V);
1717 * Set the preferred alignment of the value.
1718 * @see llvm::LoadInst::setAlignment()
1719 * @see llvm::StoreInst::setAlignment()
1720 * @see llvm::GlobalValue::setAlignment()
1722 void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes);
1729 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1731 * This group contains functions that operate on global variable values.
1733 * @see llvm::GlobalVariable
1737 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1738 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1740 unsigned AddressSpace);
1741 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1742 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1743 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1744 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1745 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1746 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1747 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1748 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1749 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1750 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1751 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1752 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1753 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1754 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1755 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1756 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1763 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1765 * This group contains function that operate on global alias values.
1767 * @see llvm::GlobalAlias
1771 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1779 * @defgroup LLVMCCoreValueFunction Function values
1781 * Functions in this group operate on LLVMValueRef instances that
1782 * correspond to llvm::Function instances.
1784 * @see llvm::Function
1790 * Remove a function from its containing module and deletes it.
1792 * @see llvm::Function::eraseFromParent()
1794 void LLVMDeleteFunction(LLVMValueRef Fn);
1797 * Obtain the ID number from a function instance.
1799 * @see llvm::Function::getIntrinsicID()
1801 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1804 * Obtain the calling function of a function.
1806 * The returned value corresponds to the LLVMCallConv enumeration.
1808 * @see llvm::Function::getCallingConv()
1810 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1813 * Set the calling convention of a function.
1815 * @see llvm::Function::setCallingConv()
1817 * @param Fn Function to operate on
1818 * @param CC LLVMCallConv to set calling convention to
1820 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1823 * Obtain the name of the garbage collector to use during code
1826 * @see llvm::Function::getGC()
1828 const char *LLVMGetGC(LLVMValueRef Fn);
1831 * Define the garbage collector to use during code generation.
1833 * @see llvm::Function::setGC()
1835 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1838 * Add an attribute to a function.
1840 * @see llvm::Function::addAttribute()
1842 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1845 * Add a target-dependent attribute to a fuction
1846 * @see llvm::AttrBuilder::addAttribute()
1848 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1852 * Obtain an attribute from a function.
1854 * @see llvm::Function::getAttributes()
1856 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1859 * Remove an attribute from a function.
1861 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1864 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1866 * Functions in this group relate to arguments/parameters on functions.
1868 * Functions in this group expect LLVMValueRef instances that correspond
1869 * to llvm::Function instances.
1875 * Obtain the number of parameters in a function.
1877 * @see llvm::Function::arg_size()
1879 unsigned LLVMCountParams(LLVMValueRef Fn);
1882 * Obtain the parameters in a function.
1884 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1885 * at least LLVMCountParams() long. This array will be filled with
1886 * LLVMValueRef instances which correspond to the parameters the
1887 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1890 * @see llvm::Function::arg_begin()
1892 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
1895 * Obtain the parameter at the specified index.
1897 * Parameters are indexed from 0.
1899 * @see llvm::Function::arg_begin()
1901 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
1904 * Obtain the function to which this argument belongs.
1906 * Unlike other functions in this group, this one takes an LLVMValueRef
1907 * that corresponds to a llvm::Attribute.
1909 * The returned LLVMValueRef is the llvm::Function to which this
1912 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
1915 * Obtain the first parameter to a function.
1917 * @see llvm::Function::arg_begin()
1919 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
1922 * Obtain the last parameter to a function.
1924 * @see llvm::Function::arg_end()
1926 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
1929 * Obtain the next parameter to a function.
1931 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
1932 * actually a wrapped iterator) and obtains the next parameter from the
1933 * underlying iterator.
1935 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
1938 * Obtain the previous parameter to a function.
1940 * This is the opposite of LLVMGetNextParam().
1942 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
1945 * Add an attribute to a function argument.
1947 * @see llvm::Argument::addAttr()
1949 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1952 * Remove an attribute from a function argument.
1954 * @see llvm::Argument::removeAttr()
1956 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
1959 * Get an attribute from a function argument.
1961 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
1964 * Set the alignment for a function parameter.
1966 * @see llvm::Argument::addAttr()
1967 * @see llvm::AttrBuilder::addAlignmentAttr()
1969 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
1988 * @defgroup LLVMCCoreValueMetadata Metadata
1994 * Obtain a MDString value from a context.
1996 * The returned instance corresponds to the llvm::MDString class.
1998 * The instance is specified by string data of a specified length. The
1999 * string content is copied, so the backing memory can be freed after
2000 * this function returns.
2002 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
2006 * Obtain a MDString value from the global context.
2008 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
2011 * Obtain a MDNode value from a context.
2013 * The returned value corresponds to the llvm::MDNode class.
2015 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
2019 * Obtain a MDNode value from the global context.
2021 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
2024 * Obtain the underlying string from a MDString value.
2026 * @param V Instance to obtain string from.
2027 * @param Len Memory address which will hold length of returned string.
2028 * @return String data in MDString.
2030 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
2033 * Obtain the number of operands from an MDNode value.
2035 * @param V MDNode to get number of operands from.
2036 * @return Number of operands of the MDNode.
2038 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
2041 * Obtain the given MDNode's operands.
2043 * The passed LLVMValueRef pointer should point to enough memory to hold all of
2044 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
2045 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
2046 * MDNode's operands.
2048 * @param V MDNode to get the operands from.
2049 * @param Dest Destination array for operands.
2051 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
2058 * @defgroup LLVMCCoreValueBasicBlock Basic Block
2060 * A basic block represents a single entry single exit section of code.
2061 * Basic blocks contain a list of instructions which form the body of
2064 * Basic blocks belong to functions. They have the type of label.
2066 * Basic blocks are themselves values. However, the C API models them as
2067 * LLVMBasicBlockRef.
2069 * @see llvm::BasicBlock
2075 * Convert a basic block instance to a value type.
2077 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
2080 * Determine whether an LLVMValueRef is itself a basic block.
2082 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
2085 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
2087 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
2090 * Obtain the function to which a basic block belongs.
2092 * @see llvm::BasicBlock::getParent()
2094 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2097 * Obtain the terminator instruction for a basic block.
2099 * If the basic block does not have a terminator (it is not well-formed
2100 * if it doesn't), then NULL is returned.
2102 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2104 * @see llvm::BasicBlock::getTerminator()
2106 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2109 * Obtain the number of basic blocks in a function.
2111 * @param Fn Function value to operate on.
2113 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2116 * Obtain all of the basic blocks in a function.
2118 * This operates on a function value. The BasicBlocks parameter is a
2119 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2120 * LLVMCountBasicBlocks() in length. This array is populated with
2121 * LLVMBasicBlockRef instances.
2123 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2126 * Obtain the first basic block in a function.
2128 * The returned basic block can be used as an iterator. You will likely
2129 * eventually call into LLVMGetNextBasicBlock() with it.
2131 * @see llvm::Function::begin()
2133 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2136 * Obtain the last basic block in a function.
2138 * @see llvm::Function::end()
2140 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2143 * Advance a basic block iterator.
2145 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2148 * Go backwards in a basic block iterator.
2150 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2153 * Obtain the basic block that corresponds to the entry point of a
2156 * @see llvm::Function::getEntryBlock()
2158 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2161 * Append a basic block to the end of a function.
2163 * @see llvm::BasicBlock::Create()
2165 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2170 * Append a basic block to the end of a function using the global
2173 * @see llvm::BasicBlock::Create()
2175 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2178 * Insert a basic block in a function before another basic block.
2180 * The function to add to is determined by the function of the
2181 * passed basic block.
2183 * @see llvm::BasicBlock::Create()
2185 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2186 LLVMBasicBlockRef BB,
2190 * Insert a basic block in a function using the global context.
2192 * @see llvm::BasicBlock::Create()
2194 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2198 * Remove a basic block from a function and delete it.
2200 * This deletes the basic block from its containing function and deletes
2201 * the basic block itself.
2203 * @see llvm::BasicBlock::eraseFromParent()
2205 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2208 * Remove a basic block from a function.
2210 * This deletes the basic block from its containing function but keep
2211 * the basic block alive.
2213 * @see llvm::BasicBlock::removeFromParent()
2215 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2218 * Move a basic block to before another one.
2220 * @see llvm::BasicBlock::moveBefore()
2222 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2225 * Move a basic block to after another one.
2227 * @see llvm::BasicBlock::moveAfter()
2229 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2232 * Obtain the first instruction in a basic block.
2234 * The returned LLVMValueRef corresponds to a llvm::Instruction
2237 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2240 * Obtain the last instruction in a basic block.
2242 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2244 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2251 * @defgroup LLVMCCoreValueInstruction Instructions
2253 * Functions in this group relate to the inspection and manipulation of
2254 * individual instructions.
2256 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2257 * class has a large number of descendents. llvm::Instruction is a
2258 * llvm::Value and in the C API, instructions are modeled by
2261 * This group also contains sub-groups which operate on specific
2262 * llvm::Instruction types, e.g. llvm::CallInst.
2268 * Determine whether an instruction has any metadata attached.
2270 int LLVMHasMetadata(LLVMValueRef Val);
2273 * Return metadata associated with an instruction value.
2275 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2278 * Set metadata associated with an instruction value.
2280 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2283 * Obtain the basic block to which an instruction belongs.
2285 * @see llvm::Instruction::getParent()
2287 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2290 * Obtain the instruction that occurs after the one specified.
2292 * The next instruction will be from the same basic block.
2294 * If this is the last instruction in a basic block, NULL will be
2297 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2300 * Obtain the instruction that occurred before this one.
2302 * If the instruction is the first instruction in a basic block, NULL
2305 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2308 * Remove and delete an instruction.
2310 * The instruction specified is removed from its containing building
2311 * block and then deleted.
2313 * @see llvm::Instruction::eraseFromParent()
2315 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2318 * Obtain the code opcode for an individual instruction.
2320 * @see llvm::Instruction::getOpCode()
2322 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2325 * Obtain the predicate of an instruction.
2327 * This is only valid for instructions that correspond to llvm::ICmpInst
2328 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2330 * @see llvm::ICmpInst::getPredicate()
2332 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2335 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2337 * Functions in this group apply to instructions that refer to call
2338 * sites and invocations. These correspond to C++ types in the
2339 * llvm::CallInst class tree.
2345 * Set the calling convention for a call instruction.
2347 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2350 * @see llvm::CallInst::setCallingConv()
2351 * @see llvm::InvokeInst::setCallingConv()
2353 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2356 * Obtain the calling convention for a call instruction.
2358 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2361 * @see LLVMSetInstructionCallConv()
2363 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2366 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2367 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2369 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2373 * Obtain whether a call instruction is a tail call.
2375 * This only works on llvm::CallInst instructions.
2377 * @see llvm::CallInst::isTailCall()
2379 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2382 * Set whether a call instruction is a tail call.
2384 * This only works on llvm::CallInst instructions.
2386 * @see llvm::CallInst::setTailCall()
2388 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2395 * Obtain the default destination basic block of a switch instruction.
2397 * This only works on llvm::SwitchInst instructions.
2399 * @see llvm::SwitchInst::getDefaultDest()
2401 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2404 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2406 * Functions in this group only apply to instructions that map to
2407 * llvm::PHINode instances.
2413 * Add an incoming value to the end of a PHI list.
2415 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2416 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2419 * Obtain the number of incoming basic blocks to a PHI node.
2421 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2424 * Obtain an incoming value to a PHI node as an LLVMValueRef.
2426 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2429 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2431 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2446 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2448 * An instruction builder represents a point within a basic block and is
2449 * the exclusive means of building instructions using the C interface.
2454 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2455 LLVMBuilderRef LLVMCreateBuilder(void);
2456 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2457 LLVMValueRef Instr);
2458 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2459 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2460 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2461 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2462 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2463 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2465 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2468 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2469 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2470 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2473 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2474 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2475 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2477 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2478 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2479 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2480 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2481 LLVMBasicBlockRef Else, unsigned NumCases);
2482 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2484 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2485 LLVMValueRef *Args, unsigned NumArgs,
2486 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2488 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2489 LLVMValueRef PersFn, unsigned NumClauses,
2491 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2492 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2494 /* Add a case to the switch instruction */
2495 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2496 LLVMBasicBlockRef Dest);
2498 /* Add a destination to the indirectbr instruction */
2499 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2501 /* Add a catch or filter clause to the landingpad instruction */
2502 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2504 /* Set the 'cleanup' flag in the landingpad instruction */
2505 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2508 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2510 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2512 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2514 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2516 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2518 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2520 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2522 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2524 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2526 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2528 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2530 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2532 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2534 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2536 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2538 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2540 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2542 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2544 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2546 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2548 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2550 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2552 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2554 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2556 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2558 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2559 LLVMValueRef LHS, LLVMValueRef RHS,
2561 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2562 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2564 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2566 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2567 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2570 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2571 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2572 LLVMValueRef Val, const char *Name);
2573 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2574 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2575 LLVMValueRef Val, const char *Name);
2576 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2577 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2579 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2580 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2581 LLVMValueRef *Indices, unsigned NumIndices,
2583 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2584 LLVMValueRef *Indices, unsigned NumIndices,
2586 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2587 unsigned Idx, const char *Name);
2588 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2590 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2592 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2593 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2596 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2597 LLVMTypeRef DestTy, const char *Name);
2598 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2599 LLVMTypeRef DestTy, const char *Name);
2600 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2601 LLVMTypeRef DestTy, const char *Name);
2602 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2603 LLVMTypeRef DestTy, const char *Name);
2604 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2605 LLVMTypeRef DestTy, const char *Name);
2606 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2607 LLVMTypeRef DestTy, const char *Name);
2608 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2609 LLVMTypeRef DestTy, const char *Name);
2610 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2611 LLVMTypeRef DestTy, const char *Name);
2612 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2613 LLVMTypeRef DestTy, const char *Name);
2614 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2615 LLVMTypeRef DestTy, const char *Name);
2616 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2617 LLVMTypeRef DestTy, const char *Name);
2618 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2619 LLVMTypeRef DestTy, const char *Name);
2620 LLVMValueRef LLVMBuildAddrSpaceCast(LLVMBuilderRef, LLVMValueRef Val,
2621 LLVMTypeRef DestTy, const char *Name);
2622 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2623 LLVMTypeRef DestTy, const char *Name);
2624 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2625 LLVMTypeRef DestTy, const char *Name);
2626 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2627 LLVMTypeRef DestTy, const char *Name);
2628 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2629 LLVMTypeRef DestTy, const char *Name);
2630 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2631 LLVMTypeRef DestTy, const char *Name);
2632 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2633 LLVMTypeRef DestTy, const char *Name);
2634 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2635 LLVMTypeRef DestTy, const char *Name);
2638 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2639 LLVMValueRef LHS, LLVMValueRef RHS,
2641 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2642 LLVMValueRef LHS, LLVMValueRef RHS,
2645 /* Miscellaneous instructions */
2646 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2647 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2648 LLVMValueRef *Args, unsigned NumArgs,
2650 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2651 LLVMValueRef Then, LLVMValueRef Else,
2653 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2655 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2656 LLVMValueRef Index, const char *Name);
2657 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2658 LLVMValueRef EltVal, LLVMValueRef Index,
2660 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2661 LLVMValueRef V2, LLVMValueRef Mask,
2663 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2664 unsigned Index, const char *Name);
2665 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2666 LLVMValueRef EltVal, unsigned Index,
2669 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2671 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2673 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2674 LLVMValueRef RHS, const char *Name);
2675 LLVMValueRef LLVMBuildFence(LLVMBuilderRef B, LLVMAtomicOrdering ordering,
2676 LLVMBool singleThread, const char *Name);
2677 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B, LLVMAtomicRMWBinOp op,
2678 LLVMValueRef PTR, LLVMValueRef Val,
2679 LLVMAtomicOrdering ordering,
2680 LLVMBool singleThread);
2687 * @defgroup LLVMCCoreModuleProvider Module Providers
2693 * Changes the type of M so it can be passed to FunctionPassManagers and the
2694 * JIT. They take ModuleProviders for historical reasons.
2696 LLVMModuleProviderRef
2697 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2700 * Destroys the module M.
2702 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2709 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2714 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2715 LLVMMemoryBufferRef *OutMemBuf,
2717 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2719 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2720 size_t InputDataLength,
2721 const char *BufferName,
2722 LLVMBool RequiresNullTerminator);
2723 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2724 size_t InputDataLength,
2725 const char *BufferName);
2726 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2727 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2728 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2735 * @defgroup LLVMCCorePassRegistry Pass Registry
2740 /** Return the global pass registry, for use with initialization functions.
2741 @see llvm::PassRegistry::getPassRegistry */
2742 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2749 * @defgroup LLVMCCorePassManagers Pass Managers
2754 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2755 suitable for link-time optimization and whole-module transformations.
2756 @see llvm::PassManager::PassManager */
2757 LLVMPassManagerRef LLVMCreatePassManager(void);
2759 /** Constructs a new function-by-function pass pipeline over the module
2760 provider. It does not take ownership of the module provider. This type of
2761 pipeline is suitable for code generation and JIT compilation tasks.
2762 @see llvm::FunctionPassManager::FunctionPassManager */
2763 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2765 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2766 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2768 /** Initializes, executes on the provided module, and finalizes all of the
2769 passes scheduled in the pass manager. Returns 1 if any of the passes
2770 modified the module, 0 otherwise.
2771 @see llvm::PassManager::run(Module&) */
2772 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2774 /** Initializes all of the function passes scheduled in the function pass
2775 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2776 @see llvm::FunctionPassManager::doInitialization */
2777 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2779 /** Executes all of the function passes scheduled in the function pass manager
2780 on the provided function. Returns 1 if any of the passes modified the
2781 function, false otherwise.
2782 @see llvm::FunctionPassManager::run(Function&) */
2783 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2785 /** Finalizes all of the function passes scheduled in in the function pass
2786 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2787 @see llvm::FunctionPassManager::doFinalization */
2788 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2790 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2791 the module provider.
2792 @see llvm::PassManagerBase::~PassManagerBase. */
2793 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2800 * @defgroup LLVMCCoreThreading Threading
2802 * Handle the structures needed to make LLVM safe for multithreading.
2807 /** Allocate and initialize structures needed to make LLVM safe for
2808 multithreading. The return value indicates whether multithreaded
2809 initialization succeeded. Must be executed in isolation from all
2810 other LLVM api calls.
2811 @see llvm::llvm_start_multithreaded */
2812 LLVMBool LLVMStartMultithreaded(void);
2814 /** Deallocate structures necessary to make LLVM safe for multithreading.
2815 Must be executed in isolation from all other LLVM api calls.
2816 @see llvm::llvm_stop_multithreaded */
2817 void LLVMStopMultithreaded(void);
2819 /** Check whether LLVM is executing in thread-safe mode or not.
2820 @see llvm::llvm_is_multithreaded */
2821 LLVMBool LLVMIsMultithreaded(void);
2837 #endif /* !defined(__cplusplus) */
2839 #endif /* !defined(LLVM_C_CORE_H) */