1 /*===-- llvm-c/Core.h - Core Library C Interface ------------------*- C -*-===*\
3 |* The LLVM Compiler Infrastructure *|
5 |* This file is distributed under the University of Illinois Open Source *|
6 |* License. See LICENSE.TXT for details. *|
8 |*===----------------------------------------------------------------------===*|
10 |* This header declares the C interface to libLLVMCore.a, which implements *|
11 |* the LLVM intermediate representation. *|
13 \*===----------------------------------------------------------------------===*/
18 #include "llvm-c/Support.h"
25 * @defgroup LLVMC LLVM-C: C interface to LLVM
27 * This module exposes parts of the LLVM library as a C API.
33 * @defgroup LLVMCTransforms Transforms
37 * @defgroup LLVMCCore Core
39 * This modules provide an interface to libLLVMCore, which implements
40 * the LLVM intermediate representation as well as other related types
43 * LLVM uses a polymorphic type hierarchy which C cannot represent, therefore
44 * parameters must be passed as base types. Despite the declared types, most
45 * of the functions provided operate only on branches of the type hierarchy.
46 * The declared parameter names are descriptive and specify which type is
47 * required. Additionally, each type hierarchy is documented along with the
48 * functions that operate upon it. For more detail, refer to LLVM's C++ code.
49 * If in doubt, refer to Core.cpp, which performs parameter downcasts in the
50 * form unwrap<RequiredType>(Param).
52 * Many exotic languages can interoperate with C code but have a harder time
53 * with C++ due to name mangling. So in addition to C, this interface enables
54 * tools written in such languages.
60 * @defgroup LLVMCCoreTypes Types and Enumerations
68 * The top-level container for all LLVM global data. See the LLVMContext class.
70 typedef struct LLVMOpaqueContext *LLVMContextRef;
73 * The top-level container for all other LLVM Intermediate Representation (IR)
78 typedef struct LLVMOpaqueModule *LLVMModuleRef;
81 * Each value in the LLVM IR has a type, an LLVMTypeRef.
85 typedef struct LLVMOpaqueType *LLVMTypeRef;
88 * Represents an individual value in LLVM IR.
90 * This models llvm::Value.
92 typedef struct LLVMOpaqueValue *LLVMValueRef;
95 * Represents a basic block of instructions in LLVM IR.
97 * This models llvm::BasicBlock.
99 typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
102 * Represents an LLVM basic block builder.
104 * This models llvm::IRBuilder.
106 typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
109 * Interface used to provide a module to JIT or interpreter.
110 * This is now just a synonym for llvm::Module, but we have to keep using the
111 * different type to keep binary compatibility.
113 typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
115 /** @see llvm::PassManagerBase */
116 typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
118 /** @see llvm::PassRegistry */
119 typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef;
122 * Used to get the users and usees of a Value.
125 typedef struct LLVMOpaqueUse *LLVMUseRef;
129 * @see llvm::DiagnosticInfo
131 typedef struct LLVMOpaqueDiagnosticInfo *LLVMDiagnosticInfoRef;
134 LLVMZExtAttribute = 1<<0,
135 LLVMSExtAttribute = 1<<1,
136 LLVMNoReturnAttribute = 1<<2,
137 LLVMInRegAttribute = 1<<3,
138 LLVMStructRetAttribute = 1<<4,
139 LLVMNoUnwindAttribute = 1<<5,
140 LLVMNoAliasAttribute = 1<<6,
141 LLVMByValAttribute = 1<<7,
142 LLVMNestAttribute = 1<<8,
143 LLVMReadNoneAttribute = 1<<9,
144 LLVMReadOnlyAttribute = 1<<10,
145 LLVMNoInlineAttribute = 1<<11,
146 LLVMAlwaysInlineAttribute = 1<<12,
147 LLVMOptimizeForSizeAttribute = 1<<13,
148 LLVMStackProtectAttribute = 1<<14,
149 LLVMStackProtectReqAttribute = 1<<15,
150 LLVMAlignment = 31<<16,
151 LLVMNoCaptureAttribute = 1<<21,
152 LLVMNoRedZoneAttribute = 1<<22,
153 LLVMNoImplicitFloatAttribute = 1<<23,
154 LLVMNakedAttribute = 1<<24,
155 LLVMInlineHintAttribute = 1<<25,
156 LLVMStackAlignment = 7<<26,
157 LLVMReturnsTwice = 1 << 29,
158 LLVMUWTable = 1 << 30,
159 LLVMNonLazyBind = 1 << 31
161 /* FIXME: These attributes are currently not included in the C API as
162 a temporary measure until the API/ABI impact to the C API is understood
163 and the path forward agreed upon.
164 LLVMSanitizeAddressAttribute = 1ULL << 32,
165 LLVMStackProtectStrongAttribute = 1ULL<<35,
166 LLVMColdAttribute = 1ULL << 40,
167 LLVMOptimizeNoneAttribute = 1ULL << 42,
168 LLVMInAllocaAttribute = 1ULL << 43,
169 LLVMNonNullAttribute = 1ULL << 44,
170 LLVMJumpTableAttribute = 1ULL << 45,
171 LLVMConvergentAttribute = 1ULL << 46,
172 LLVMSafeStackAttribute = 1ULL << 47,
177 /* Terminator Instructions */
183 /* removed 6 due to API changes */
186 /* Standard Binary Operators */
200 /* Logical Operators */
208 /* Memory Operators */
212 LLVMGetElementPtr = 29,
227 LLVMAddrSpaceCast = 60,
229 /* Other Operators */
238 LLVMExtractElement = 50,
239 LLVMInsertElement = 51,
240 LLVMShuffleVector = 52,
241 LLVMExtractValue = 53,
242 LLVMInsertValue = 54,
244 /* Atomic operators */
246 LLVMAtomicCmpXchg = 56,
249 /* Exception Handling Operators */
255 LLVMTerminateBlock = 64,
256 LLVMCleanupBlock = 65,
257 LLVMCatchEndBlock = 66
262 LLVMVoidTypeKind, /**< type with no size */
263 LLVMHalfTypeKind, /**< 16 bit floating point type */
264 LLVMFloatTypeKind, /**< 32 bit floating point type */
265 LLVMDoubleTypeKind, /**< 64 bit floating point type */
266 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
267 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
268 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
269 LLVMLabelTypeKind, /**< Labels */
270 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
271 LLVMFunctionTypeKind, /**< Functions */
272 LLVMStructTypeKind, /**< Structures */
273 LLVMArrayTypeKind, /**< Arrays */
274 LLVMPointerTypeKind, /**< Pointers */
275 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
276 LLVMMetadataTypeKind, /**< Metadata */
277 LLVMX86_MMXTypeKind /**< X86 MMX */
281 LLVMExternalLinkage, /**< Externally visible function */
282 LLVMAvailableExternallyLinkage,
283 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
284 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
286 LLVMLinkOnceODRAutoHideLinkage, /**< Obsolete */
287 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
288 LLVMWeakODRLinkage, /**< Same, but only replaced by something
290 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
291 LLVMInternalLinkage, /**< Rename collisions when linking (static
293 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
294 LLVMDLLImportLinkage, /**< Obsolete */
295 LLVMDLLExportLinkage, /**< Obsolete */
296 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
297 LLVMGhostLinkage, /**< Obsolete */
298 LLVMCommonLinkage, /**< Tentative definitions */
299 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
300 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
304 LLVMDefaultVisibility, /**< The GV is visible */
305 LLVMHiddenVisibility, /**< The GV is hidden */
306 LLVMProtectedVisibility /**< The GV is protected */
310 LLVMDefaultStorageClass = 0,
311 LLVMDLLImportStorageClass = 1, /**< Function to be imported from DLL. */
312 LLVMDLLExportStorageClass = 2 /**< Function to be accessible from DLL. */
313 } LLVMDLLStorageClass;
317 LLVMFastCallConv = 8,
318 LLVMColdCallConv = 9,
319 LLVMWebKitJSCallConv = 12,
320 LLVMAnyRegCallConv = 13,
321 LLVMX86StdcallCallConv = 64,
322 LLVMX86FastcallCallConv = 65
326 LLVMIntEQ = 32, /**< equal */
327 LLVMIntNE, /**< not equal */
328 LLVMIntUGT, /**< unsigned greater than */
329 LLVMIntUGE, /**< unsigned greater or equal */
330 LLVMIntULT, /**< unsigned less than */
331 LLVMIntULE, /**< unsigned less or equal */
332 LLVMIntSGT, /**< signed greater than */
333 LLVMIntSGE, /**< signed greater or equal */
334 LLVMIntSLT, /**< signed less than */
335 LLVMIntSLE /**< signed less or equal */
339 LLVMRealPredicateFalse, /**< Always false (always folded) */
340 LLVMRealOEQ, /**< True if ordered and equal */
341 LLVMRealOGT, /**< True if ordered and greater than */
342 LLVMRealOGE, /**< True if ordered and greater than or equal */
343 LLVMRealOLT, /**< True if ordered and less than */
344 LLVMRealOLE, /**< True if ordered and less than or equal */
345 LLVMRealONE, /**< True if ordered and operands are unequal */
346 LLVMRealORD, /**< True if ordered (no nans) */
347 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
348 LLVMRealUEQ, /**< True if unordered or equal */
349 LLVMRealUGT, /**< True if unordered or greater than */
350 LLVMRealUGE, /**< True if unordered, greater than, or equal */
351 LLVMRealULT, /**< True if unordered or less than */
352 LLVMRealULE, /**< True if unordered, less than, or equal */
353 LLVMRealUNE, /**< True if unordered or not equal */
354 LLVMRealPredicateTrue /**< Always true (always folded) */
358 LLVMLandingPadCatch, /**< A catch clause */
359 LLVMLandingPadFilter /**< A filter clause */
360 } LLVMLandingPadClauseTy;
363 LLVMNotThreadLocal = 0,
364 LLVMGeneralDynamicTLSModel,
365 LLVMLocalDynamicTLSModel,
366 LLVMInitialExecTLSModel,
367 LLVMLocalExecTLSModel
368 } LLVMThreadLocalMode;
371 LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */
372 LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees
373 somewhat sane results, lock free. */
374 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the
375 operations affecting a specific address,
376 a consistent ordering exists */
377 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort
378 necessary to acquire a lock to access other
379 memory with normal loads and stores. */
380 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with
381 a barrier of the sort necessary to release
383 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
384 Release barrier (for fences and
385 operations which both read and write
387 LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics
388 for loads and Release
389 semantics for stores.
390 Additionally, it guarantees
391 that a total ordering exists
393 SequentiallyConsistent
395 } LLVMAtomicOrdering;
398 LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */
399 LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */
400 LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */
401 LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */
402 LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */
403 LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */
404 LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */
405 LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the
406 original using a signed comparison and return
408 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
409 original using a signed comparison and return
411 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
412 original using an unsigned comparison and return
414 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
415 original using an unsigned comparison and return
417 } LLVMAtomicRMWBinOp;
424 } LLVMDiagnosticSeverity;
430 void LLVMInitializeCore(LLVMPassRegistryRef R);
432 /** Deallocate and destroy all ManagedStatic variables.
433 @see llvm::llvm_shutdown
434 @see ManagedStatic */
435 void LLVMShutdown(void);
438 /*===-- Error handling ----------------------------------------------------===*/
440 char *LLVMCreateMessage(const char *Message);
441 void LLVMDisposeMessage(char *Message);
443 typedef void (*LLVMFatalErrorHandler)(const char *Reason);
446 * Install a fatal error handler. By default, if LLVM detects a fatal error, it
447 * will call exit(1). This may not be appropriate in many contexts. For example,
448 * doing exit(1) will bypass many crash reporting/tracing system tools. This
449 * function allows you to install a callback that will be invoked prior to the
452 void LLVMInstallFatalErrorHandler(LLVMFatalErrorHandler Handler);
455 * Reset the fatal error handler. This resets LLVM's fatal error handling
456 * behavior to the default.
458 void LLVMResetFatalErrorHandler(void);
461 * Enable LLVM's built-in stack trace code. This intercepts the OS's crash
462 * signals and prints which component of LLVM you were in at the time if the
465 void LLVMEnablePrettyStackTrace(void);
468 * @defgroup LLVMCCoreContext Contexts
470 * Contexts are execution states for the core LLVM IR system.
472 * Most types are tied to a context instance. Multiple contexts can
473 * exist simultaneously. A single context is not thread safe. However,
474 * different contexts can execute on different threads simultaneously.
479 typedef void (*LLVMDiagnosticHandler)(LLVMDiagnosticInfoRef, void *);
480 typedef void (*LLVMYieldCallback)(LLVMContextRef, void *);
483 * Create a new context.
485 * Every call to this function should be paired with a call to
486 * LLVMContextDispose() or the context will leak memory.
488 LLVMContextRef LLVMContextCreate(void);
491 * Obtain the global context instance.
493 LLVMContextRef LLVMGetGlobalContext(void);
496 * Set the diagnostic handler for this context.
498 void LLVMContextSetDiagnosticHandler(LLVMContextRef C,
499 LLVMDiagnosticHandler Handler,
500 void *DiagnosticContext);
503 * Set the yield callback function for this context.
505 * @see LLVMContext::setYieldCallback()
507 void LLVMContextSetYieldCallback(LLVMContextRef C, LLVMYieldCallback Callback,
511 * Destroy a context instance.
513 * This should be called for every call to LLVMContextCreate() or memory
516 void LLVMContextDispose(LLVMContextRef C);
519 * Return a string representation of the DiagnosticInfo. Use
520 * LLVMDisposeMessage to free the string.
522 * @see DiagnosticInfo::print()
524 char *LLVMGetDiagInfoDescription(LLVMDiagnosticInfoRef DI);
527 * Return an enum LLVMDiagnosticSeverity.
529 * @see DiagnosticInfo::getSeverity()
531 LLVMDiagnosticSeverity LLVMGetDiagInfoSeverity(LLVMDiagnosticInfoRef DI);
533 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
535 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
542 * @defgroup LLVMCCoreModule Modules
544 * Modules represent the top-level structure in an LLVM program. An LLVM
545 * module is effectively a translation unit or a collection of
546 * translation units merged together.
552 * Create a new, empty module in the global context.
554 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
555 * LLVMGetGlobalContext() as the context parameter.
557 * Every invocation should be paired with LLVMDisposeModule() or memory
560 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
563 * Create a new, empty module in a specific context.
565 * Every invocation should be paired with LLVMDisposeModule() or memory
568 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
571 * Return an exact copy of the specified module.
573 LLVMModuleRef LLVMCloneModule(LLVMModuleRef M);
576 * Destroy a module instance.
578 * This must be called for every created module or memory will be
581 void LLVMDisposeModule(LLVMModuleRef M);
584 * Obtain the data layout for a module.
586 * @see Module::getDataLayout()
588 const char *LLVMGetDataLayout(LLVMModuleRef M);
591 * Set the data layout for a module.
593 * @see Module::setDataLayout()
595 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
598 * Obtain the target triple for a module.
600 * @see Module::getTargetTriple()
602 const char *LLVMGetTarget(LLVMModuleRef M);
605 * Set the target triple for a module.
607 * @see Module::setTargetTriple()
609 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
612 * Dump a representation of a module to stderr.
614 * @see Module::dump()
616 void LLVMDumpModule(LLVMModuleRef M);
619 * Print a representation of a module to a file. The ErrorMessage needs to be
620 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
622 * @see Module::print()
624 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
625 char **ErrorMessage);
628 * Return a string representation of the module. Use
629 * LLVMDisposeMessage to free the string.
631 * @see Module::print()
633 char *LLVMPrintModuleToString(LLVMModuleRef M);
636 * Set inline assembly for a module.
638 * @see Module::setModuleInlineAsm()
640 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
643 * Obtain the context to which this module is associated.
645 * @see Module::getContext()
647 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
650 * Obtain a Type from a module by its registered name.
652 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
655 * Obtain the number of operands for named metadata in a module.
657 * @see llvm::Module::getNamedMetadata()
659 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
662 * Obtain the named metadata operands for a module.
664 * The passed LLVMValueRef pointer should refer to an array of
665 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
666 * array will be populated with the LLVMValueRef instances. Each
667 * instance corresponds to a llvm::MDNode.
669 * @see llvm::Module::getNamedMetadata()
670 * @see llvm::MDNode::getOperand()
672 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
675 * Add an operand to named metadata.
677 * @see llvm::Module::getNamedMetadata()
678 * @see llvm::MDNode::addOperand()
680 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
684 * Add a function to a module under a specified name.
686 * @see llvm::Function::Create()
688 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
689 LLVMTypeRef FunctionTy);
692 * Obtain a Function value from a Module by its name.
694 * The returned value corresponds to a llvm::Function value.
696 * @see llvm::Module::getFunction()
698 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
701 * Obtain an iterator to the first Function in a Module.
703 * @see llvm::Module::begin()
705 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
708 * Obtain an iterator to the last Function in a Module.
710 * @see llvm::Module::end()
712 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
715 * Advance a Function iterator to the next Function.
717 * Returns NULL if the iterator was already at the end and there are no more
720 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
723 * Decrement a Function iterator to the previous Function.
725 * Returns NULL if the iterator was already at the beginning and there are
726 * no previous functions.
728 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
735 * @defgroup LLVMCCoreType Types
737 * Types represent the type of a value.
739 * Types are associated with a context instance. The context internally
740 * deduplicates types so there is only 1 instance of a specific type
741 * alive at a time. In other words, a unique type is shared among all
742 * consumers within a context.
744 * A Type in the C API corresponds to llvm::Type.
746 * Types have the following hierarchy:
764 * Obtain the enumerated type of a Type instance.
766 * @see llvm::Type:getTypeID()
768 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
771 * Whether the type has a known size.
773 * Things that don't have a size are abstract types, labels, and void.a
775 * @see llvm::Type::isSized()
777 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
780 * Obtain the context to which this type instance is associated.
782 * @see llvm::Type::getContext()
784 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
787 * Dump a representation of a type to stderr.
789 * @see llvm::Type::dump()
791 void LLVMDumpType(LLVMTypeRef Val);
794 * Return a string representation of the type. Use
795 * LLVMDisposeMessage to free the string.
797 * @see llvm::Type::print()
799 char *LLVMPrintTypeToString(LLVMTypeRef Val);
802 * @defgroup LLVMCCoreTypeInt Integer Types
804 * Functions in this section operate on integer types.
810 * Obtain an integer type from a context with specified bit width.
812 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
813 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
814 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
815 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
816 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
817 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
820 * Obtain an integer type from the global context with a specified bit
823 LLVMTypeRef LLVMInt1Type(void);
824 LLVMTypeRef LLVMInt8Type(void);
825 LLVMTypeRef LLVMInt16Type(void);
826 LLVMTypeRef LLVMInt32Type(void);
827 LLVMTypeRef LLVMInt64Type(void);
828 LLVMTypeRef LLVMIntType(unsigned NumBits);
829 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
836 * @defgroup LLVMCCoreTypeFloat Floating Point Types
842 * Obtain a 16-bit floating point type from a context.
844 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
847 * Obtain a 32-bit floating point type from a context.
849 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
852 * Obtain a 64-bit floating point type from a context.
854 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
857 * Obtain a 80-bit floating point type (X87) from a context.
859 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
862 * Obtain a 128-bit floating point type (112-bit mantissa) from a
865 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
868 * Obtain a 128-bit floating point type (two 64-bits) from a context.
870 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
873 * Obtain a floating point type from the global context.
875 * These map to the functions in this group of the same name.
877 LLVMTypeRef LLVMHalfType(void);
878 LLVMTypeRef LLVMFloatType(void);
879 LLVMTypeRef LLVMDoubleType(void);
880 LLVMTypeRef LLVMX86FP80Type(void);
881 LLVMTypeRef LLVMFP128Type(void);
882 LLVMTypeRef LLVMPPCFP128Type(void);
889 * @defgroup LLVMCCoreTypeFunction Function Types
895 * Obtain a function type consisting of a specified signature.
897 * The function is defined as a tuple of a return Type, a list of
898 * parameter types, and whether the function is variadic.
900 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
901 LLVMTypeRef *ParamTypes, unsigned ParamCount,
905 * Returns whether a function type is variadic.
907 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
910 * Obtain the Type this function Type returns.
912 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
915 * Obtain the number of parameters this function accepts.
917 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
920 * Obtain the types of a function's parameters.
922 * The Dest parameter should point to a pre-allocated array of
923 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
924 * first LLVMCountParamTypes() entries in the array will be populated
925 * with LLVMTypeRef instances.
927 * @param FunctionTy The function type to operate on.
928 * @param Dest Memory address of an array to be filled with result.
930 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
937 * @defgroup LLVMCCoreTypeStruct Structure Types
939 * These functions relate to LLVMTypeRef instances.
941 * @see llvm::StructType
947 * Create a new structure type in a context.
949 * A structure is specified by a list of inner elements/types and
950 * whether these can be packed together.
952 * @see llvm::StructType::create()
954 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
955 unsigned ElementCount, LLVMBool Packed);
958 * Create a new structure type in the global context.
960 * @see llvm::StructType::create()
962 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
966 * Create an empty structure in a context having a specified name.
968 * @see llvm::StructType::create()
970 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
973 * Obtain the name of a structure.
975 * @see llvm::StructType::getName()
977 const char *LLVMGetStructName(LLVMTypeRef Ty);
980 * Set the contents of a structure type.
982 * @see llvm::StructType::setBody()
984 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
985 unsigned ElementCount, LLVMBool Packed);
988 * Get the number of elements defined inside the structure.
990 * @see llvm::StructType::getNumElements()
992 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
995 * Get the elements within a structure.
997 * The function is passed the address of a pre-allocated array of
998 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
999 * invocation, this array will be populated with the structure's
1000 * elements. The objects in the destination array will have a lifetime
1001 * of the structure type itself, which is the lifetime of the context it
1004 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
1007 * Get the type of the element at a given index in the structure.
1009 * @see llvm::StructType::getTypeAtIndex()
1011 LLVMTypeRef LLVMStructGetTypeAtIndex(LLVMTypeRef StructTy, unsigned i);
1014 * Determine whether a structure is packed.
1016 * @see llvm::StructType::isPacked()
1018 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
1021 * Determine whether a structure is opaque.
1023 * @see llvm::StructType::isOpaque()
1025 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
1033 * @defgroup LLVMCCoreTypeSequential Sequential Types
1035 * Sequential types represents "arrays" of types. This is a super class
1036 * for array, vector, and pointer types.
1042 * Obtain the type of elements within a sequential type.
1044 * This works on array, vector, and pointer types.
1046 * @see llvm::SequentialType::getElementType()
1048 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
1051 * Create a fixed size array type that refers to a specific type.
1053 * The created type will exist in the context that its element type
1056 * @see llvm::ArrayType::get()
1058 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
1061 * Obtain the length of an array type.
1063 * This only works on types that represent arrays.
1065 * @see llvm::ArrayType::getNumElements()
1067 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
1070 * Create a pointer type that points to a defined type.
1072 * The created type will exist in the context that its pointee type
1075 * @see llvm::PointerType::get()
1077 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
1080 * Obtain the address space of a pointer type.
1082 * This only works on types that represent pointers.
1084 * @see llvm::PointerType::getAddressSpace()
1086 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
1089 * Create a vector type that contains a defined type and has a specific
1090 * number of elements.
1092 * The created type will exist in the context thats its element type
1095 * @see llvm::VectorType::get()
1097 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
1100 * Obtain the number of elements in a vector type.
1102 * This only works on types that represent vectors.
1104 * @see llvm::VectorType::getNumElements()
1106 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1113 * @defgroup LLVMCCoreTypeOther Other Types
1119 * Create a void type in a context.
1121 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1124 * Create a label type in a context.
1126 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1129 * Create a X86 MMX type in a context.
1131 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1134 * These are similar to the above functions except they operate on the
1137 LLVMTypeRef LLVMVoidType(void);
1138 LLVMTypeRef LLVMLabelType(void);
1139 LLVMTypeRef LLVMX86MMXType(void);
1150 * @defgroup LLVMCCoreValues Values
1152 * The bulk of LLVM's object model consists of values, which comprise a very
1153 * rich type hierarchy.
1155 * LLVMValueRef essentially represents llvm::Value. There is a rich
1156 * hierarchy of classes within this type. Depending on the instance
1157 * obtained, not all APIs are available.
1159 * Callers can determine the type of an LLVMValueRef by calling the
1160 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1161 * functions are defined by a macro, so it isn't obvious which are
1162 * available by looking at the Doxygen source code. Instead, look at the
1163 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1164 * of value names given. These value names also correspond to classes in
1165 * the llvm::Value hierarchy.
1170 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1176 macro(BlockAddress) \
1177 macro(ConstantAggregateZero) \
1178 macro(ConstantArray) \
1179 macro(ConstantDataSequential) \
1180 macro(ConstantDataArray) \
1181 macro(ConstantDataVector) \
1182 macro(ConstantExpr) \
1184 macro(ConstantInt) \
1185 macro(ConstantPointerNull) \
1186 macro(ConstantStruct) \
1187 macro(ConstantVector) \
1188 macro(GlobalValue) \
1189 macro(GlobalAlias) \
1190 macro(GlobalObject) \
1192 macro(GlobalVariable) \
1194 macro(Instruction) \
1195 macro(BinaryOperator) \
1197 macro(IntrinsicInst) \
1198 macro(DbgInfoIntrinsic) \
1199 macro(DbgDeclareInst) \
1200 macro(MemIntrinsic) \
1202 macro(MemMoveInst) \
1207 macro(ExtractElementInst) \
1208 macro(GetElementPtrInst) \
1209 macro(InsertElementInst) \
1210 macro(InsertValueInst) \
1211 macro(LandingPadInst) \
1212 macro(CleanupBlockInst) \
1215 macro(ShuffleVectorInst) \
1217 macro(TerminatorInst) \
1219 macro(IndirectBrInst) \
1223 macro(UnreachableInst) \
1225 macro(CleanupReturnInst) \
1226 macro(CatchReturnInst) \
1227 macro(CatchBlockInst) \
1228 macro(TerminateBlockInst) \
1229 macro(CatchEndBlockInst) \
1230 macro(UnaryInstruction) \
1233 macro(AddrSpaceCastInst) \
1234 macro(BitCastInst) \
1238 macro(FPTruncInst) \
1239 macro(IntToPtrInst) \
1240 macro(PtrToIntInst) \
1246 macro(ExtractValueInst) \
1251 * @defgroup LLVMCCoreValueGeneral General APIs
1253 * Functions in this section work on all LLVMValueRef instances,
1254 * regardless of their sub-type. They correspond to functions available
1261 * Obtain the type of a value.
1263 * @see llvm::Value::getType()
1265 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1268 * Obtain the string name of a value.
1270 * @see llvm::Value::getName()
1272 const char *LLVMGetValueName(LLVMValueRef Val);
1275 * Set the string name of a value.
1277 * @see llvm::Value::setName()
1279 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1282 * Dump a representation of a value to stderr.
1284 * @see llvm::Value::dump()
1286 void LLVMDumpValue(LLVMValueRef Val);
1289 * Return a string representation of the value. Use
1290 * LLVMDisposeMessage to free the string.
1292 * @see llvm::Value::print()
1294 char *LLVMPrintValueToString(LLVMValueRef Val);
1297 * Replace all uses of a value with another one.
1299 * @see llvm::Value::replaceAllUsesWith()
1301 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1304 * Determine whether the specified constant instance is constant.
1306 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1309 * Determine whether a value instance is undefined.
1311 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1314 * Convert value instances between types.
1316 * Internally, an LLVMValueRef is "pinned" to a specific type. This
1317 * series of functions allows you to cast an instance to a specific
1320 * If the cast is not valid for the specified type, NULL is returned.
1322 * @see llvm::dyn_cast_or_null<>
1324 #define LLVM_DECLARE_VALUE_CAST(name) \
1325 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1326 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1328 LLVMValueRef LLVMIsAMDNode(LLVMValueRef Val);
1329 LLVMValueRef LLVMIsAMDString(LLVMValueRef Val);
1336 * @defgroup LLVMCCoreValueUses Usage
1338 * This module defines functions that allow you to inspect the uses of a
1341 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1342 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1343 * llvm::User and llvm::Value.
1349 * Obtain the first use of a value.
1351 * Uses are obtained in an iterator fashion. First, call this function
1352 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1353 * on that instance and all subsequently obtained instances until
1354 * LLVMGetNextUse() returns NULL.
1356 * @see llvm::Value::use_begin()
1358 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1361 * Obtain the next use of a value.
1363 * This effectively advances the iterator. It returns NULL if you are on
1364 * the final use and no more are available.
1366 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1369 * Obtain the user value for a user.
1371 * The returned value corresponds to a llvm::User type.
1373 * @see llvm::Use::getUser()
1375 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1378 * Obtain the value this use corresponds to.
1380 * @see llvm::Use::get().
1382 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1389 * @defgroup LLVMCCoreValueUser User value
1391 * Function in this group pertain to LLVMValueRef instances that descent
1392 * from llvm::User. This includes constants, instructions, and
1399 * Obtain an operand at a specific index in a llvm::User value.
1401 * @see llvm::User::getOperand()
1403 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1406 * Obtain the use of an operand at a specific index in a llvm::User value.
1408 * @see llvm::User::getOperandUse()
1410 LLVMUseRef LLVMGetOperandUse(LLVMValueRef Val, unsigned Index);
1413 * Set an operand at a specific index in a llvm::User value.
1415 * @see llvm::User::setOperand()
1417 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1420 * Obtain the number of operands in a llvm::User value.
1422 * @see llvm::User::getNumOperands()
1424 int LLVMGetNumOperands(LLVMValueRef Val);
1431 * @defgroup LLVMCCoreValueConstant Constants
1433 * This section contains APIs for interacting with LLVMValueRef that
1434 * correspond to llvm::Constant instances.
1436 * These functions will work for any LLVMValueRef in the llvm::Constant
1443 * Obtain a constant value referring to the null instance of a type.
1445 * @see llvm::Constant::getNullValue()
1447 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1450 * Obtain a constant value referring to the instance of a type
1451 * consisting of all ones.
1453 * This is only valid for integer types.
1455 * @see llvm::Constant::getAllOnesValue()
1457 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1460 * Obtain a constant value referring to an undefined value of a type.
1462 * @see llvm::UndefValue::get()
1464 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1467 * Determine whether a value instance is null.
1469 * @see llvm::Constant::isNullValue()
1471 LLVMBool LLVMIsNull(LLVMValueRef Val);
1474 * Obtain a constant that is a constant pointer pointing to NULL for a
1477 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1480 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1482 * Functions in this group model LLVMValueRef instances that correspond
1483 * to constants referring to scalar types.
1485 * For integer types, the LLVMTypeRef parameter should correspond to a
1486 * llvm::IntegerType instance and the returned LLVMValueRef will
1487 * correspond to a llvm::ConstantInt.
1489 * For floating point types, the LLVMTypeRef returned corresponds to a
1496 * Obtain a constant value for an integer type.
1498 * The returned value corresponds to a llvm::ConstantInt.
1500 * @see llvm::ConstantInt::get()
1502 * @param IntTy Integer type to obtain value of.
1503 * @param N The value the returned instance should refer to.
1504 * @param SignExtend Whether to sign extend the produced value.
1506 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1507 LLVMBool SignExtend);
1510 * Obtain a constant value for an integer of arbitrary precision.
1512 * @see llvm::ConstantInt::get()
1514 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1516 const uint64_t Words[]);
1519 * Obtain a constant value for an integer parsed from a string.
1521 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1522 * string's length is available, it is preferred to call that function
1525 * @see llvm::ConstantInt::get()
1527 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1531 * Obtain a constant value for an integer parsed from a string with
1534 * @see llvm::ConstantInt::get()
1536 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1537 unsigned SLen, uint8_t Radix);
1540 * Obtain a constant value referring to a double floating point value.
1542 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1545 * Obtain a constant for a floating point value parsed from a string.
1547 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1548 * should be used if the input string's length is known.
1550 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1553 * Obtain a constant for a floating point value parsed from a string.
1555 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1559 * Obtain the zero extended value for an integer constant value.
1561 * @see llvm::ConstantInt::getZExtValue()
1563 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1566 * Obtain the sign extended value for an integer constant value.
1568 * @see llvm::ConstantInt::getSExtValue()
1570 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1573 * Obtain the double value for an floating point constant value.
1574 * losesInfo indicates if some precision was lost in the conversion.
1576 * @see llvm::ConstantFP::getDoubleValue
1578 double LLVMConstRealGetDouble(LLVMValueRef ConstantVal, LLVMBool *losesInfo);
1585 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1587 * Functions in this group operate on composite constants.
1593 * Create a ConstantDataSequential and initialize it with a string.
1595 * @see llvm::ConstantDataArray::getString()
1597 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1598 unsigned Length, LLVMBool DontNullTerminate);
1601 * Create a ConstantDataSequential with string content in the global context.
1603 * This is the same as LLVMConstStringInContext except it operates on the
1606 * @see LLVMConstStringInContext()
1607 * @see llvm::ConstantDataArray::getString()
1609 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1610 LLVMBool DontNullTerminate);
1613 * Returns true if the specified constant is an array of i8.
1615 * @see ConstantDataSequential::getAsString()
1617 LLVMBool LLVMIsConstantString(LLVMValueRef c);
1620 * Get the given constant data sequential as a string.
1622 * @see ConstantDataSequential::getAsString()
1624 const char *LLVMGetAsString(LLVMValueRef c, size_t* out);
1627 * Create an anonymous ConstantStruct with the specified values.
1629 * @see llvm::ConstantStruct::getAnon()
1631 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1632 LLVMValueRef *ConstantVals,
1633 unsigned Count, LLVMBool Packed);
1636 * Create a ConstantStruct in the global Context.
1638 * This is the same as LLVMConstStructInContext except it operates on the
1641 * @see LLVMConstStructInContext()
1643 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1647 * Create a ConstantArray from values.
1649 * @see llvm::ConstantArray::get()
1651 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1652 LLVMValueRef *ConstantVals, unsigned Length);
1655 * Create a non-anonymous ConstantStruct from values.
1657 * @see llvm::ConstantStruct::get()
1659 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1660 LLVMValueRef *ConstantVals,
1664 * Get an element at specified index as a constant.
1666 * @see ConstantDataSequential::getElementAsConstant()
1668 LLVMValueRef LLVMGetElementAsConstant(LLVMValueRef c, unsigned idx);
1671 * Create a ConstantVector from values.
1673 * @see llvm::ConstantVector::get()
1675 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1682 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1684 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1686 * @see llvm::ConstantExpr.
1690 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1691 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1692 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1693 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1694 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1695 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1696 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1697 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1698 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1699 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1700 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1701 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1702 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1703 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1704 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1705 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1706 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1707 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1708 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1709 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1710 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1711 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1712 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1713 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1714 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1715 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1716 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1717 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1718 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1719 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1720 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1721 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1722 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1723 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1724 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1725 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1726 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1727 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1728 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1729 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1730 LLVMValueRef *ConstantIndices,
1731 unsigned NumIndices);
1732 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1733 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1734 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1735 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1736 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1737 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1738 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1739 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1740 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1741 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1742 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1743 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1744 LLVMValueRef LLVMConstAddrSpaceCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1745 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1746 LLVMTypeRef ToType);
1747 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1748 LLVMTypeRef ToType);
1749 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1750 LLVMTypeRef ToType);
1751 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1752 LLVMTypeRef ToType);
1753 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1755 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1756 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1757 LLVMValueRef ConstantIfTrue,
1758 LLVMValueRef ConstantIfFalse);
1759 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1760 LLVMValueRef IndexConstant);
1761 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1762 LLVMValueRef ElementValueConstant,
1763 LLVMValueRef IndexConstant);
1764 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1765 LLVMValueRef VectorBConstant,
1766 LLVMValueRef MaskConstant);
1767 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1769 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1770 LLVMValueRef ElementValueConstant,
1771 unsigned *IdxList, unsigned NumIdx);
1772 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1773 const char *AsmString, const char *Constraints,
1774 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1775 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1782 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1784 * This group contains functions that operate on global values. Functions in
1785 * this group relate to functions in the llvm::GlobalValue class tree.
1787 * @see llvm::GlobalValue
1792 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1793 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1794 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1795 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1796 const char *LLVMGetSection(LLVMValueRef Global);
1797 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1798 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1799 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1800 LLVMDLLStorageClass LLVMGetDLLStorageClass(LLVMValueRef Global);
1801 void LLVMSetDLLStorageClass(LLVMValueRef Global, LLVMDLLStorageClass Class);
1802 LLVMBool LLVMHasUnnamedAddr(LLVMValueRef Global);
1803 void LLVMSetUnnamedAddr(LLVMValueRef Global, LLVMBool HasUnnamedAddr);
1806 * @defgroup LLVMCCoreValueWithAlignment Values with alignment
1808 * Functions in this group only apply to values with alignment, i.e.
1809 * global variables, load and store instructions.
1813 * Obtain the preferred alignment of the value.
1814 * @see llvm::AllocaInst::getAlignment()
1815 * @see llvm::LoadInst::getAlignment()
1816 * @see llvm::StoreInst::getAlignment()
1817 * @see llvm::GlobalValue::getAlignment()
1819 unsigned LLVMGetAlignment(LLVMValueRef V);
1822 * Set the preferred alignment of the value.
1823 * @see llvm::AllocaInst::setAlignment()
1824 * @see llvm::LoadInst::setAlignment()
1825 * @see llvm::StoreInst::setAlignment()
1826 * @see llvm::GlobalValue::setAlignment()
1828 void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes);
1835 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1837 * This group contains functions that operate on global variable values.
1839 * @see llvm::GlobalVariable
1843 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1844 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1846 unsigned AddressSpace);
1847 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1848 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1849 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1850 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1851 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1852 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1853 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1854 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1855 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1856 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1857 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1858 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1859 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1860 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1861 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1862 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1869 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1871 * This group contains function that operate on global alias values.
1873 * @see llvm::GlobalAlias
1877 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1885 * @defgroup LLVMCCoreValueFunction Function values
1887 * Functions in this group operate on LLVMValueRef instances that
1888 * correspond to llvm::Function instances.
1890 * @see llvm::Function
1896 * Remove a function from its containing module and deletes it.
1898 * @see llvm::Function::eraseFromParent()
1900 void LLVMDeleteFunction(LLVMValueRef Fn);
1903 * Obtain the ID number from a function instance.
1905 * @see llvm::Function::getIntrinsicID()
1907 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1910 * Obtain the calling function of a function.
1912 * The returned value corresponds to the LLVMCallConv enumeration.
1914 * @see llvm::Function::getCallingConv()
1916 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1919 * Set the calling convention of a function.
1921 * @see llvm::Function::setCallingConv()
1923 * @param Fn Function to operate on
1924 * @param CC LLVMCallConv to set calling convention to
1926 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1929 * Obtain the name of the garbage collector to use during code
1932 * @see llvm::Function::getGC()
1934 const char *LLVMGetGC(LLVMValueRef Fn);
1937 * Define the garbage collector to use during code generation.
1939 * @see llvm::Function::setGC()
1941 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1944 * Add an attribute to a function.
1946 * @see llvm::Function::addAttribute()
1948 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1951 * Add a target-dependent attribute to a fuction
1952 * @see llvm::AttrBuilder::addAttribute()
1954 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1958 * Obtain an attribute from a function.
1960 * @see llvm::Function::getAttributes()
1962 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1965 * Remove an attribute from a function.
1967 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1970 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1972 * Functions in this group relate to arguments/parameters on functions.
1974 * Functions in this group expect LLVMValueRef instances that correspond
1975 * to llvm::Function instances.
1981 * Obtain the number of parameters in a function.
1983 * @see llvm::Function::arg_size()
1985 unsigned LLVMCountParams(LLVMValueRef Fn);
1988 * Obtain the parameters in a function.
1990 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
1991 * at least LLVMCountParams() long. This array will be filled with
1992 * LLVMValueRef instances which correspond to the parameters the
1993 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
1996 * @see llvm::Function::arg_begin()
1998 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
2001 * Obtain the parameter at the specified index.
2003 * Parameters are indexed from 0.
2005 * @see llvm::Function::arg_begin()
2007 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
2010 * Obtain the function to which this argument belongs.
2012 * Unlike other functions in this group, this one takes an LLVMValueRef
2013 * that corresponds to a llvm::Attribute.
2015 * The returned LLVMValueRef is the llvm::Function to which this
2018 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
2021 * Obtain the first parameter to a function.
2023 * @see llvm::Function::arg_begin()
2025 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
2028 * Obtain the last parameter to a function.
2030 * @see llvm::Function::arg_end()
2032 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
2035 * Obtain the next parameter to a function.
2037 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
2038 * actually a wrapped iterator) and obtains the next parameter from the
2039 * underlying iterator.
2041 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
2044 * Obtain the previous parameter to a function.
2046 * This is the opposite of LLVMGetNextParam().
2048 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
2051 * Add an attribute to a function argument.
2053 * @see llvm::Argument::addAttr()
2055 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
2058 * Remove an attribute from a function argument.
2060 * @see llvm::Argument::removeAttr()
2062 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
2065 * Get an attribute from a function argument.
2067 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
2070 * Set the alignment for a function parameter.
2072 * @see llvm::Argument::addAttr()
2073 * @see llvm::AttrBuilder::addAlignmentAttr()
2075 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
2094 * @defgroup LLVMCCoreValueMetadata Metadata
2100 * Obtain a MDString value from a context.
2102 * The returned instance corresponds to the llvm::MDString class.
2104 * The instance is specified by string data of a specified length. The
2105 * string content is copied, so the backing memory can be freed after
2106 * this function returns.
2108 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
2112 * Obtain a MDString value from the global context.
2114 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
2117 * Obtain a MDNode value from a context.
2119 * The returned value corresponds to the llvm::MDNode class.
2121 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
2125 * Obtain a MDNode value from the global context.
2127 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
2130 * Obtain the underlying string from a MDString value.
2132 * @param V Instance to obtain string from.
2133 * @param Len Memory address which will hold length of returned string.
2134 * @return String data in MDString.
2136 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
2139 * Obtain the number of operands from an MDNode value.
2141 * @param V MDNode to get number of operands from.
2142 * @return Number of operands of the MDNode.
2144 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
2147 * Obtain the given MDNode's operands.
2149 * The passed LLVMValueRef pointer should point to enough memory to hold all of
2150 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
2151 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
2152 * MDNode's operands.
2154 * @param V MDNode to get the operands from.
2155 * @param Dest Destination array for operands.
2157 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
2164 * @defgroup LLVMCCoreValueBasicBlock Basic Block
2166 * A basic block represents a single entry single exit section of code.
2167 * Basic blocks contain a list of instructions which form the body of
2170 * Basic blocks belong to functions. They have the type of label.
2172 * Basic blocks are themselves values. However, the C API models them as
2173 * LLVMBasicBlockRef.
2175 * @see llvm::BasicBlock
2181 * Convert a basic block instance to a value type.
2183 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
2186 * Determine whether an LLVMValueRef is itself a basic block.
2188 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
2191 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
2193 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
2196 * Obtain the function to which a basic block belongs.
2198 * @see llvm::BasicBlock::getParent()
2200 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2203 * Obtain the terminator instruction for a basic block.
2205 * If the basic block does not have a terminator (it is not well-formed
2206 * if it doesn't), then NULL is returned.
2208 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2210 * @see llvm::BasicBlock::getTerminator()
2212 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2215 * Obtain the number of basic blocks in a function.
2217 * @param Fn Function value to operate on.
2219 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2222 * Obtain all of the basic blocks in a function.
2224 * This operates on a function value. The BasicBlocks parameter is a
2225 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2226 * LLVMCountBasicBlocks() in length. This array is populated with
2227 * LLVMBasicBlockRef instances.
2229 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2232 * Obtain the first basic block in a function.
2234 * The returned basic block can be used as an iterator. You will likely
2235 * eventually call into LLVMGetNextBasicBlock() with it.
2237 * @see llvm::Function::begin()
2239 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2242 * Obtain the last basic block in a function.
2244 * @see llvm::Function::end()
2246 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2249 * Advance a basic block iterator.
2251 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2254 * Go backwards in a basic block iterator.
2256 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2259 * Obtain the basic block that corresponds to the entry point of a
2262 * @see llvm::Function::getEntryBlock()
2264 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2267 * Append a basic block to the end of a function.
2269 * @see llvm::BasicBlock::Create()
2271 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2276 * Append a basic block to the end of a function using the global
2279 * @see llvm::BasicBlock::Create()
2281 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2284 * Insert a basic block in a function before another basic block.
2286 * The function to add to is determined by the function of the
2287 * passed basic block.
2289 * @see llvm::BasicBlock::Create()
2291 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2292 LLVMBasicBlockRef BB,
2296 * Insert a basic block in a function using the global context.
2298 * @see llvm::BasicBlock::Create()
2300 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2304 * Remove a basic block from a function and delete it.
2306 * This deletes the basic block from its containing function and deletes
2307 * the basic block itself.
2309 * @see llvm::BasicBlock::eraseFromParent()
2311 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2314 * Remove a basic block from a function.
2316 * This deletes the basic block from its containing function but keep
2317 * the basic block alive.
2319 * @see llvm::BasicBlock::removeFromParent()
2321 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2324 * Move a basic block to before another one.
2326 * @see llvm::BasicBlock::moveBefore()
2328 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2331 * Move a basic block to after another one.
2333 * @see llvm::BasicBlock::moveAfter()
2335 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2338 * Obtain the first instruction in a basic block.
2340 * The returned LLVMValueRef corresponds to a llvm::Instruction
2343 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2346 * Obtain the last instruction in a basic block.
2348 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2350 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2357 * @defgroup LLVMCCoreValueInstruction Instructions
2359 * Functions in this group relate to the inspection and manipulation of
2360 * individual instructions.
2362 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2363 * class has a large number of descendents. llvm::Instruction is a
2364 * llvm::Value and in the C API, instructions are modeled by
2367 * This group also contains sub-groups which operate on specific
2368 * llvm::Instruction types, e.g. llvm::CallInst.
2374 * Determine whether an instruction has any metadata attached.
2376 int LLVMHasMetadata(LLVMValueRef Val);
2379 * Return metadata associated with an instruction value.
2381 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2384 * Set metadata associated with an instruction value.
2386 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2389 * Obtain the basic block to which an instruction belongs.
2391 * @see llvm::Instruction::getParent()
2393 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2396 * Obtain the instruction that occurs after the one specified.
2398 * The next instruction will be from the same basic block.
2400 * If this is the last instruction in a basic block, NULL will be
2403 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2406 * Obtain the instruction that occurred before this one.
2408 * If the instruction is the first instruction in a basic block, NULL
2411 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2414 * Remove and delete an instruction.
2416 * The instruction specified is removed from its containing building
2417 * block and then deleted.
2419 * @see llvm::Instruction::eraseFromParent()
2421 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2424 * Obtain the code opcode for an individual instruction.
2426 * @see llvm::Instruction::getOpCode()
2428 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2431 * Obtain the predicate of an instruction.
2433 * This is only valid for instructions that correspond to llvm::ICmpInst
2434 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2436 * @see llvm::ICmpInst::getPredicate()
2438 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2441 * Obtain the float predicate of an instruction.
2443 * This is only valid for instructions that correspond to llvm::FCmpInst
2444 * or llvm::ConstantExpr whose opcode is llvm::Instruction::FCmp.
2446 * @see llvm::FCmpInst::getPredicate()
2448 LLVMRealPredicate LLVMGetFCmpPredicate(LLVMValueRef Inst);
2451 * Create a copy of 'this' instruction that is identical in all ways
2452 * except the following:
2453 * * The instruction has no parent
2454 * * The instruction has no name
2456 * @see llvm::Instruction::clone()
2458 LLVMValueRef LLVMInstructionClone(LLVMValueRef Inst);
2461 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2463 * Functions in this group apply to instructions that refer to call
2464 * sites and invocations. These correspond to C++ types in the
2465 * llvm::CallInst class tree.
2471 * Set the calling convention for a call instruction.
2473 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2476 * @see llvm::CallInst::setCallingConv()
2477 * @see llvm::InvokeInst::setCallingConv()
2479 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2482 * Obtain the calling convention for a call instruction.
2484 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2487 * @see LLVMSetInstructionCallConv()
2489 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2492 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2493 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2495 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2499 * Obtain whether a call instruction is a tail call.
2501 * This only works on llvm::CallInst instructions.
2503 * @see llvm::CallInst::isTailCall()
2505 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2508 * Set whether a call instruction is a tail call.
2510 * This only works on llvm::CallInst instructions.
2512 * @see llvm::CallInst::setTailCall()
2514 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2521 * @defgroup LLVMCCoreValueInstructionTerminator Terminators
2523 * Functions in this group only apply to instructions that map to
2524 * llvm::TerminatorInst instances.
2530 * Return the number of successors that this terminator has.
2532 * @see llvm::TerminatorInst::getNumSuccessors
2534 unsigned LLVMGetNumSuccessors(LLVMValueRef Term);
2537 * Return the specified successor.
2539 * @see llvm::TerminatorInst::getSuccessor
2541 LLVMBasicBlockRef LLVMGetSuccessor(LLVMValueRef Term, unsigned i);
2544 * Update the specified successor to point at the provided block.
2546 * @see llvm::TerminatorInst::setSuccessor
2548 void LLVMSetSuccessor(LLVMValueRef Term, unsigned i, LLVMBasicBlockRef block);
2551 * Return if a branch is conditional.
2553 * This only works on llvm::BranchInst instructions.
2555 * @see llvm::BranchInst::isConditional
2557 LLVMBool LLVMIsConditional(LLVMValueRef Branch);
2560 * Return the condition of a branch instruction.
2562 * This only works on llvm::BranchInst instructions.
2564 * @see llvm::BranchInst::getCondition
2566 LLVMValueRef LLVMGetCondition(LLVMValueRef Branch);
2569 * Set the condition of a branch instruction.
2571 * This only works on llvm::BranchInst instructions.
2573 * @see llvm::BranchInst::setCondition
2575 void LLVMSetCondition(LLVMValueRef Branch, LLVMValueRef Cond);
2578 * Obtain the default destination basic block of a switch instruction.
2580 * This only works on llvm::SwitchInst instructions.
2582 * @see llvm::SwitchInst::getDefaultDest()
2584 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2591 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2593 * Functions in this group only apply to instructions that map to
2594 * llvm::PHINode instances.
2600 * Add an incoming value to the end of a PHI list.
2602 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2603 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2606 * Obtain the number of incoming basic blocks to a PHI node.
2608 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2611 * Obtain an incoming value to a PHI node as an LLVMValueRef.
2613 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2616 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2618 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2633 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2635 * An instruction builder represents a point within a basic block and is
2636 * the exclusive means of building instructions using the C interface.
2641 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2642 LLVMBuilderRef LLVMCreateBuilder(void);
2643 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2644 LLVMValueRef Instr);
2645 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2646 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2647 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2648 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2649 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2650 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2652 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2655 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2656 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2657 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2660 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2661 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2662 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2664 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2665 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2666 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2667 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2668 LLVMBasicBlockRef Else, unsigned NumCases);
2669 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2671 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2672 LLVMValueRef *Args, unsigned NumArgs,
2673 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2675 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2676 unsigned NumClauses, const char *Name);
2677 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2678 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2680 /* Add a case to the switch instruction */
2681 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2682 LLVMBasicBlockRef Dest);
2684 /* Add a destination to the indirectbr instruction */
2685 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2687 /* Add a catch or filter clause to the landingpad instruction */
2688 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2690 /* Set the 'cleanup' flag in the landingpad instruction */
2691 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2694 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2696 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2698 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2700 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2702 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2704 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2706 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2708 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2710 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2712 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2714 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2716 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2718 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2720 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2722 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2724 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2726 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2728 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2730 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2732 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2734 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2736 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2738 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2740 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2742 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2744 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2745 LLVMValueRef LHS, LLVMValueRef RHS,
2747 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2748 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2750 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2752 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2753 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2756 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2757 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2758 LLVMValueRef Val, const char *Name);
2759 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2760 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2761 LLVMValueRef Val, const char *Name);
2762 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2763 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2765 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2766 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2767 LLVMValueRef *Indices, unsigned NumIndices,
2769 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2770 LLVMValueRef *Indices, unsigned NumIndices,
2772 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2773 unsigned Idx, const char *Name);
2774 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2776 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2778 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2779 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2782 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2783 LLVMTypeRef DestTy, const char *Name);
2784 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2785 LLVMTypeRef DestTy, const char *Name);
2786 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2787 LLVMTypeRef DestTy, const char *Name);
2788 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2789 LLVMTypeRef DestTy, const char *Name);
2790 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2791 LLVMTypeRef DestTy, const char *Name);
2792 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2793 LLVMTypeRef DestTy, const char *Name);
2794 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2795 LLVMTypeRef DestTy, const char *Name);
2796 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2797 LLVMTypeRef DestTy, const char *Name);
2798 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2799 LLVMTypeRef DestTy, const char *Name);
2800 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2801 LLVMTypeRef DestTy, const char *Name);
2802 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2803 LLVMTypeRef DestTy, const char *Name);
2804 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2805 LLVMTypeRef DestTy, const char *Name);
2806 LLVMValueRef LLVMBuildAddrSpaceCast(LLVMBuilderRef, LLVMValueRef Val,
2807 LLVMTypeRef DestTy, const char *Name);
2808 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2809 LLVMTypeRef DestTy, const char *Name);
2810 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2811 LLVMTypeRef DestTy, const char *Name);
2812 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2813 LLVMTypeRef DestTy, const char *Name);
2814 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2815 LLVMTypeRef DestTy, const char *Name);
2816 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2817 LLVMTypeRef DestTy, const char *Name);
2818 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2819 LLVMTypeRef DestTy, const char *Name);
2820 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2821 LLVMTypeRef DestTy, const char *Name);
2824 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2825 LLVMValueRef LHS, LLVMValueRef RHS,
2827 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2828 LLVMValueRef LHS, LLVMValueRef RHS,
2831 /* Miscellaneous instructions */
2832 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2833 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2834 LLVMValueRef *Args, unsigned NumArgs,
2836 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2837 LLVMValueRef Then, LLVMValueRef Else,
2839 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2841 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2842 LLVMValueRef Index, const char *Name);
2843 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2844 LLVMValueRef EltVal, LLVMValueRef Index,
2846 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2847 LLVMValueRef V2, LLVMValueRef Mask,
2849 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2850 unsigned Index, const char *Name);
2851 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2852 LLVMValueRef EltVal, unsigned Index,
2855 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2857 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2859 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2860 LLVMValueRef RHS, const char *Name);
2861 LLVMValueRef LLVMBuildFence(LLVMBuilderRef B, LLVMAtomicOrdering ordering,
2862 LLVMBool singleThread, const char *Name);
2863 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B, LLVMAtomicRMWBinOp op,
2864 LLVMValueRef PTR, LLVMValueRef Val,
2865 LLVMAtomicOrdering ordering,
2866 LLVMBool singleThread);
2873 * @defgroup LLVMCCoreModuleProvider Module Providers
2879 * Changes the type of M so it can be passed to FunctionPassManagers and the
2880 * JIT. They take ModuleProviders for historical reasons.
2882 LLVMModuleProviderRef
2883 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2886 * Destroys the module M.
2888 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2895 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2900 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2901 LLVMMemoryBufferRef *OutMemBuf,
2903 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2905 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2906 size_t InputDataLength,
2907 const char *BufferName,
2908 LLVMBool RequiresNullTerminator);
2909 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2910 size_t InputDataLength,
2911 const char *BufferName);
2912 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2913 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2914 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2921 * @defgroup LLVMCCorePassRegistry Pass Registry
2926 /** Return the global pass registry, for use with initialization functions.
2927 @see llvm::PassRegistry::getPassRegistry */
2928 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2935 * @defgroup LLVMCCorePassManagers Pass Managers
2940 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2941 suitable for link-time optimization and whole-module transformations.
2942 @see llvm::PassManager::PassManager */
2943 LLVMPassManagerRef LLVMCreatePassManager(void);
2945 /** Constructs a new function-by-function pass pipeline over the module
2946 provider. It does not take ownership of the module provider. This type of
2947 pipeline is suitable for code generation and JIT compilation tasks.
2948 @see llvm::FunctionPassManager::FunctionPassManager */
2949 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2951 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2952 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2954 /** Initializes, executes on the provided module, and finalizes all of the
2955 passes scheduled in the pass manager. Returns 1 if any of the passes
2956 modified the module, 0 otherwise.
2957 @see llvm::PassManager::run(Module&) */
2958 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2960 /** Initializes all of the function passes scheduled in the function pass
2961 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2962 @see llvm::FunctionPassManager::doInitialization */
2963 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2965 /** Executes all of the function passes scheduled in the function pass manager
2966 on the provided function. Returns 1 if any of the passes modified the
2967 function, false otherwise.
2968 @see llvm::FunctionPassManager::run(Function&) */
2969 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2971 /** Finalizes all of the function passes scheduled in in the function pass
2972 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2973 @see llvm::FunctionPassManager::doFinalization */
2974 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2976 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2977 the module provider.
2978 @see llvm::PassManagerBase::~PassManagerBase. */
2979 void LLVMDisposePassManager(LLVMPassManagerRef PM);
2986 * @defgroup LLVMCCoreThreading Threading
2988 * Handle the structures needed to make LLVM safe for multithreading.
2993 /** Deprecated: Multi-threading can only be enabled/disabled with the compile
2994 time define LLVM_ENABLE_THREADS. This function always returns
2995 LLVMIsMultithreaded(). */
2996 LLVMBool LLVMStartMultithreaded(void);
2998 /** Deprecated: Multi-threading can only be enabled/disabled with the compile
2999 time define LLVM_ENABLE_THREADS. */
3000 void LLVMStopMultithreaded(void);
3002 /** Check whether LLVM is executing in thread-safe mode or not.
3003 @see llvm::llvm_is_multithreaded */
3004 LLVMBool LLVMIsMultithreaded(void);
3020 #endif /* !defined(__cplusplus) */
3022 #endif /* !defined(LLVM_C_CORE_H) */