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 LLVMTerminatePad = 64,
257 LLVMCatchEndPad = 66,
258 LLVMCleanupEndPad = 67
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 */
278 LLVMTokenTypeKind /**< Tokens */
282 LLVMExternalLinkage, /**< Externally visible function */
283 LLVMAvailableExternallyLinkage,
284 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
285 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
287 LLVMLinkOnceODRAutoHideLinkage, /**< Obsolete */
288 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
289 LLVMWeakODRLinkage, /**< Same, but only replaced by something
291 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
292 LLVMInternalLinkage, /**< Rename collisions when linking (static
294 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
295 LLVMDLLImportLinkage, /**< Obsolete */
296 LLVMDLLExportLinkage, /**< Obsolete */
297 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
298 LLVMGhostLinkage, /**< Obsolete */
299 LLVMCommonLinkage, /**< Tentative definitions */
300 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
301 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
305 LLVMDefaultVisibility, /**< The GV is visible */
306 LLVMHiddenVisibility, /**< The GV is hidden */
307 LLVMProtectedVisibility /**< The GV is protected */
311 LLVMDefaultStorageClass = 0,
312 LLVMDLLImportStorageClass = 1, /**< Function to be imported from DLL. */
313 LLVMDLLExportStorageClass = 2 /**< Function to be accessible from DLL. */
314 } LLVMDLLStorageClass;
318 LLVMFastCallConv = 8,
319 LLVMColdCallConv = 9,
320 LLVMWebKitJSCallConv = 12,
321 LLVMAnyRegCallConv = 13,
322 LLVMX86StdcallCallConv = 64,
323 LLVMX86FastcallCallConv = 65
327 LLVMIntEQ = 32, /**< equal */
328 LLVMIntNE, /**< not equal */
329 LLVMIntUGT, /**< unsigned greater than */
330 LLVMIntUGE, /**< unsigned greater or equal */
331 LLVMIntULT, /**< unsigned less than */
332 LLVMIntULE, /**< unsigned less or equal */
333 LLVMIntSGT, /**< signed greater than */
334 LLVMIntSGE, /**< signed greater or equal */
335 LLVMIntSLT, /**< signed less than */
336 LLVMIntSLE /**< signed less or equal */
340 LLVMRealPredicateFalse, /**< Always false (always folded) */
341 LLVMRealOEQ, /**< True if ordered and equal */
342 LLVMRealOGT, /**< True if ordered and greater than */
343 LLVMRealOGE, /**< True if ordered and greater than or equal */
344 LLVMRealOLT, /**< True if ordered and less than */
345 LLVMRealOLE, /**< True if ordered and less than or equal */
346 LLVMRealONE, /**< True if ordered and operands are unequal */
347 LLVMRealORD, /**< True if ordered (no nans) */
348 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
349 LLVMRealUEQ, /**< True if unordered or equal */
350 LLVMRealUGT, /**< True if unordered or greater than */
351 LLVMRealUGE, /**< True if unordered, greater than, or equal */
352 LLVMRealULT, /**< True if unordered or less than */
353 LLVMRealULE, /**< True if unordered, less than, or equal */
354 LLVMRealUNE, /**< True if unordered or not equal */
355 LLVMRealPredicateTrue /**< Always true (always folded) */
359 LLVMLandingPadCatch, /**< A catch clause */
360 LLVMLandingPadFilter /**< A filter clause */
361 } LLVMLandingPadClauseTy;
364 LLVMNotThreadLocal = 0,
365 LLVMGeneralDynamicTLSModel,
366 LLVMLocalDynamicTLSModel,
367 LLVMInitialExecTLSModel,
368 LLVMLocalExecTLSModel
369 } LLVMThreadLocalMode;
372 LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */
373 LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees
374 somewhat sane results, lock free. */
375 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the
376 operations affecting a specific address,
377 a consistent ordering exists */
378 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort
379 necessary to acquire a lock to access other
380 memory with normal loads and stores. */
381 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with
382 a barrier of the sort necessary to release
384 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
385 Release barrier (for fences and
386 operations which both read and write
388 LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics
389 for loads and Release
390 semantics for stores.
391 Additionally, it guarantees
392 that a total ordering exists
394 SequentiallyConsistent
396 } LLVMAtomicOrdering;
399 LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */
400 LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */
401 LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */
402 LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */
403 LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */
404 LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */
405 LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */
406 LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the
407 original using a signed comparison and return
409 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
410 original using a signed comparison and return
412 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
413 original using an unsigned comparison and return
415 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
416 original using an unsigned comparison and return
418 } LLVMAtomicRMWBinOp;
425 } LLVMDiagnosticSeverity;
431 void LLVMInitializeCore(LLVMPassRegistryRef R);
433 /** Deallocate and destroy all ManagedStatic variables.
434 @see llvm::llvm_shutdown
435 @see ManagedStatic */
436 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 LLVMInt128TypeInContext(LLVMContextRef C);
818 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
821 * Obtain an integer type from the global context with a specified bit
824 LLVMTypeRef LLVMInt1Type(void);
825 LLVMTypeRef LLVMInt8Type(void);
826 LLVMTypeRef LLVMInt16Type(void);
827 LLVMTypeRef LLVMInt32Type(void);
828 LLVMTypeRef LLVMInt64Type(void);
829 LLVMTypeRef LLVMInt128Type(void);
830 LLVMTypeRef LLVMIntType(unsigned NumBits);
831 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
838 * @defgroup LLVMCCoreTypeFloat Floating Point Types
844 * Obtain a 16-bit floating point type from a context.
846 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C);
849 * Obtain a 32-bit floating point type from a context.
851 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
854 * Obtain a 64-bit floating point type from a context.
856 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
859 * Obtain a 80-bit floating point type (X87) from a context.
861 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
864 * Obtain a 128-bit floating point type (112-bit mantissa) from a
867 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
870 * Obtain a 128-bit floating point type (two 64-bits) from a context.
872 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
875 * Obtain a floating point type from the global context.
877 * These map to the functions in this group of the same name.
879 LLVMTypeRef LLVMHalfType(void);
880 LLVMTypeRef LLVMFloatType(void);
881 LLVMTypeRef LLVMDoubleType(void);
882 LLVMTypeRef LLVMX86FP80Type(void);
883 LLVMTypeRef LLVMFP128Type(void);
884 LLVMTypeRef LLVMPPCFP128Type(void);
891 * @defgroup LLVMCCoreTypeFunction Function Types
897 * Obtain a function type consisting of a specified signature.
899 * The function is defined as a tuple of a return Type, a list of
900 * parameter types, and whether the function is variadic.
902 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
903 LLVMTypeRef *ParamTypes, unsigned ParamCount,
907 * Returns whether a function type is variadic.
909 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
912 * Obtain the Type this function Type returns.
914 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
917 * Obtain the number of parameters this function accepts.
919 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
922 * Obtain the types of a function's parameters.
924 * The Dest parameter should point to a pre-allocated array of
925 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the
926 * first LLVMCountParamTypes() entries in the array will be populated
927 * with LLVMTypeRef instances.
929 * @param FunctionTy The function type to operate on.
930 * @param Dest Memory address of an array to be filled with result.
932 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
939 * @defgroup LLVMCCoreTypeStruct Structure Types
941 * These functions relate to LLVMTypeRef instances.
943 * @see llvm::StructType
949 * Create a new structure type in a context.
951 * A structure is specified by a list of inner elements/types and
952 * whether these can be packed together.
954 * @see llvm::StructType::create()
956 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
957 unsigned ElementCount, LLVMBool Packed);
960 * Create a new structure type in the global context.
962 * @see llvm::StructType::create()
964 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
968 * Create an empty structure in a context having a specified name.
970 * @see llvm::StructType::create()
972 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
975 * Obtain the name of a structure.
977 * @see llvm::StructType::getName()
979 const char *LLVMGetStructName(LLVMTypeRef Ty);
982 * Set the contents of a structure type.
984 * @see llvm::StructType::setBody()
986 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
987 unsigned ElementCount, LLVMBool Packed);
990 * Get the number of elements defined inside the structure.
992 * @see llvm::StructType::getNumElements()
994 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
997 * Get the elements within a structure.
999 * The function is passed the address of a pre-allocated array of
1000 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After
1001 * invocation, this array will be populated with the structure's
1002 * elements. The objects in the destination array will have a lifetime
1003 * of the structure type itself, which is the lifetime of the context it
1006 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
1009 * Get the type of the element at a given index in the structure.
1011 * @see llvm::StructType::getTypeAtIndex()
1013 LLVMTypeRef LLVMStructGetTypeAtIndex(LLVMTypeRef StructTy, unsigned i);
1016 * Determine whether a structure is packed.
1018 * @see llvm::StructType::isPacked()
1020 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
1023 * Determine whether a structure is opaque.
1025 * @see llvm::StructType::isOpaque()
1027 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
1034 * @defgroup LLVMCCoreTypeSequential Sequential Types
1036 * Sequential types represents "arrays" of types. This is a super class
1037 * for array, vector, and pointer types.
1043 * Obtain the type of elements within a sequential type.
1045 * This works on array, vector, and pointer types.
1047 * @see llvm::SequentialType::getElementType()
1049 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
1052 * Create a fixed size array type that refers to a specific type.
1054 * The created type will exist in the context that its element type
1057 * @see llvm::ArrayType::get()
1059 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
1062 * Obtain the length of an array type.
1064 * This only works on types that represent arrays.
1066 * @see llvm::ArrayType::getNumElements()
1068 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
1071 * Create a pointer type that points to a defined type.
1073 * The created type will exist in the context that its pointee type
1076 * @see llvm::PointerType::get()
1078 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
1081 * Obtain the address space of a pointer type.
1083 * This only works on types that represent pointers.
1085 * @see llvm::PointerType::getAddressSpace()
1087 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
1090 * Create a vector type that contains a defined type and has a specific
1091 * number of elements.
1093 * The created type will exist in the context thats its element type
1096 * @see llvm::VectorType::get()
1098 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
1101 * Obtain the number of elements in a vector type.
1103 * This only works on types that represent vectors.
1105 * @see llvm::VectorType::getNumElements()
1107 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1114 * @defgroup LLVMCCoreTypeOther Other Types
1120 * Create a void type in a context.
1122 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1125 * Create a label type in a context.
1127 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1130 * Create a X86 MMX type in a context.
1132 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1135 * These are similar to the above functions except they operate on the
1138 LLVMTypeRef LLVMVoidType(void);
1139 LLVMTypeRef LLVMLabelType(void);
1140 LLVMTypeRef LLVMX86MMXType(void);
1151 * @defgroup LLVMCCoreValues Values
1153 * The bulk of LLVM's object model consists of values, which comprise a very
1154 * rich type hierarchy.
1156 * LLVMValueRef essentially represents llvm::Value. There is a rich
1157 * hierarchy of classes within this type. Depending on the instance
1158 * obtained, not all APIs are available.
1160 * Callers can determine the type of an LLVMValueRef by calling the
1161 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1162 * functions are defined by a macro, so it isn't obvious which are
1163 * available by looking at the Doxygen source code. Instead, look at the
1164 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1165 * of value names given. These value names also correspond to classes in
1166 * the llvm::Value hierarchy.
1171 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1177 macro(BlockAddress) \
1178 macro(ConstantAggregateZero) \
1179 macro(ConstantArray) \
1180 macro(ConstantDataSequential) \
1181 macro(ConstantDataArray) \
1182 macro(ConstantDataVector) \
1183 macro(ConstantExpr) \
1185 macro(ConstantInt) \
1186 macro(ConstantPointerNull) \
1187 macro(ConstantStruct) \
1188 macro(ConstantVector) \
1189 macro(GlobalValue) \
1190 macro(GlobalAlias) \
1191 macro(GlobalObject) \
1193 macro(GlobalVariable) \
1195 macro(Instruction) \
1196 macro(BinaryOperator) \
1198 macro(IntrinsicInst) \
1199 macro(DbgInfoIntrinsic) \
1200 macro(DbgDeclareInst) \
1201 macro(MemIntrinsic) \
1203 macro(MemMoveInst) \
1208 macro(ExtractElementInst) \
1209 macro(GetElementPtrInst) \
1210 macro(InsertElementInst) \
1211 macro(InsertValueInst) \
1212 macro(LandingPadInst) \
1213 macro(CleanupPadInst) \
1216 macro(ShuffleVectorInst) \
1218 macro(TerminatorInst) \
1220 macro(IndirectBrInst) \
1224 macro(UnreachableInst) \
1226 macro(CleanupReturnInst) \
1227 macro(CatchReturnInst) \
1228 macro(CatchPadInst) \
1229 macro(TerminatePadInst) \
1230 macro(CatchEndPadInst) \
1231 macro(CleanupEndPadInst) \
1232 macro(UnaryInstruction) \
1235 macro(AddrSpaceCastInst) \
1236 macro(BitCastInst) \
1240 macro(FPTruncInst) \
1241 macro(IntToPtrInst) \
1242 macro(PtrToIntInst) \
1248 macro(ExtractValueInst) \
1253 * @defgroup LLVMCCoreValueGeneral General APIs
1255 * Functions in this section work on all LLVMValueRef instances,
1256 * regardless of their sub-type. They correspond to functions available
1263 * Obtain the type of a value.
1265 * @see llvm::Value::getType()
1267 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1270 * Obtain the string name of a value.
1272 * @see llvm::Value::getName()
1274 const char *LLVMGetValueName(LLVMValueRef Val);
1277 * Set the string name of a value.
1279 * @see llvm::Value::setName()
1281 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1284 * Dump a representation of a value to stderr.
1286 * @see llvm::Value::dump()
1288 void LLVMDumpValue(LLVMValueRef Val);
1291 * Return a string representation of the value. Use
1292 * LLVMDisposeMessage to free the string.
1294 * @see llvm::Value::print()
1296 char *LLVMPrintValueToString(LLVMValueRef Val);
1299 * Replace all uses of a value with another one.
1301 * @see llvm::Value::replaceAllUsesWith()
1303 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1306 * Determine whether the specified constant instance is constant.
1308 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1311 * Determine whether a value instance is undefined.
1313 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1316 * Convert value instances between types.
1318 * Internally, an LLVMValueRef is "pinned" to a specific type. This
1319 * series of functions allows you to cast an instance to a specific
1322 * If the cast is not valid for the specified type, NULL is returned.
1324 * @see llvm::dyn_cast_or_null<>
1326 #define LLVM_DECLARE_VALUE_CAST(name) \
1327 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1328 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1330 LLVMValueRef LLVMIsAMDNode(LLVMValueRef Val);
1331 LLVMValueRef LLVMIsAMDString(LLVMValueRef Val);
1338 * @defgroup LLVMCCoreValueUses Usage
1340 * This module defines functions that allow you to inspect the uses of a
1343 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1344 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1345 * llvm::User and llvm::Value.
1351 * Obtain the first use of a value.
1353 * Uses are obtained in an iterator fashion. First, call this function
1354 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1355 * on that instance and all subsequently obtained instances until
1356 * LLVMGetNextUse() returns NULL.
1358 * @see llvm::Value::use_begin()
1360 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1363 * Obtain the next use of a value.
1365 * This effectively advances the iterator. It returns NULL if you are on
1366 * the final use and no more are available.
1368 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1371 * Obtain the user value for a user.
1373 * The returned value corresponds to a llvm::User type.
1375 * @see llvm::Use::getUser()
1377 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1380 * Obtain the value this use corresponds to.
1382 * @see llvm::Use::get().
1384 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1391 * @defgroup LLVMCCoreValueUser User value
1393 * Function in this group pertain to LLVMValueRef instances that descent
1394 * from llvm::User. This includes constants, instructions, and
1401 * Obtain an operand at a specific index in a llvm::User value.
1403 * @see llvm::User::getOperand()
1405 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1408 * Obtain the use of an operand at a specific index in a llvm::User value.
1410 * @see llvm::User::getOperandUse()
1412 LLVMUseRef LLVMGetOperandUse(LLVMValueRef Val, unsigned Index);
1415 * Set an operand at a specific index in a llvm::User value.
1417 * @see llvm::User::setOperand()
1419 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1422 * Obtain the number of operands in a llvm::User value.
1424 * @see llvm::User::getNumOperands()
1426 int LLVMGetNumOperands(LLVMValueRef Val);
1433 * @defgroup LLVMCCoreValueConstant Constants
1435 * This section contains APIs for interacting with LLVMValueRef that
1436 * correspond to llvm::Constant instances.
1438 * These functions will work for any LLVMValueRef in the llvm::Constant
1445 * Obtain a constant value referring to the null instance of a type.
1447 * @see llvm::Constant::getNullValue()
1449 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1452 * Obtain a constant value referring to the instance of a type
1453 * consisting of all ones.
1455 * This is only valid for integer types.
1457 * @see llvm::Constant::getAllOnesValue()
1459 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1462 * Obtain a constant value referring to an undefined value of a type.
1464 * @see llvm::UndefValue::get()
1466 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1469 * Determine whether a value instance is null.
1471 * @see llvm::Constant::isNullValue()
1473 LLVMBool LLVMIsNull(LLVMValueRef Val);
1476 * Obtain a constant that is a constant pointer pointing to NULL for a
1479 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1482 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1484 * Functions in this group model LLVMValueRef instances that correspond
1485 * to constants referring to scalar types.
1487 * For integer types, the LLVMTypeRef parameter should correspond to a
1488 * llvm::IntegerType instance and the returned LLVMValueRef will
1489 * correspond to a llvm::ConstantInt.
1491 * For floating point types, the LLVMTypeRef returned corresponds to a
1498 * Obtain a constant value for an integer type.
1500 * The returned value corresponds to a llvm::ConstantInt.
1502 * @see llvm::ConstantInt::get()
1504 * @param IntTy Integer type to obtain value of.
1505 * @param N The value the returned instance should refer to.
1506 * @param SignExtend Whether to sign extend the produced value.
1508 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1509 LLVMBool SignExtend);
1512 * Obtain a constant value for an integer of arbitrary precision.
1514 * @see llvm::ConstantInt::get()
1516 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1518 const uint64_t Words[]);
1521 * Obtain a constant value for an integer parsed from a string.
1523 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1524 * string's length is available, it is preferred to call that function
1527 * @see llvm::ConstantInt::get()
1529 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1533 * Obtain a constant value for an integer parsed from a string with
1536 * @see llvm::ConstantInt::get()
1538 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1539 unsigned SLen, uint8_t Radix);
1542 * Obtain a constant value referring to a double floating point value.
1544 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1547 * Obtain a constant for a floating point value parsed from a string.
1549 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1550 * should be used if the input string's length is known.
1552 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1555 * Obtain a constant for a floating point value parsed from a string.
1557 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1561 * Obtain the zero extended value for an integer constant value.
1563 * @see llvm::ConstantInt::getZExtValue()
1565 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1568 * Obtain the sign extended value for an integer constant value.
1570 * @see llvm::ConstantInt::getSExtValue()
1572 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1575 * Obtain the double value for an floating point constant value.
1576 * losesInfo indicates if some precision was lost in the conversion.
1578 * @see llvm::ConstantFP::getDoubleValue
1580 double LLVMConstRealGetDouble(LLVMValueRef ConstantVal, LLVMBool *losesInfo);
1587 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1589 * Functions in this group operate on composite constants.
1595 * Create a ConstantDataSequential and initialize it with a string.
1597 * @see llvm::ConstantDataArray::getString()
1599 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1600 unsigned Length, LLVMBool DontNullTerminate);
1603 * Create a ConstantDataSequential with string content in the global context.
1605 * This is the same as LLVMConstStringInContext except it operates on the
1608 * @see LLVMConstStringInContext()
1609 * @see llvm::ConstantDataArray::getString()
1611 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1612 LLVMBool DontNullTerminate);
1615 * Returns true if the specified constant is an array of i8.
1617 * @see ConstantDataSequential::getAsString()
1619 LLVMBool LLVMIsConstantString(LLVMValueRef c);
1622 * Get the given constant data sequential as a string.
1624 * @see ConstantDataSequential::getAsString()
1626 const char *LLVMGetAsString(LLVMValueRef c, size_t* out);
1629 * Create an anonymous ConstantStruct with the specified values.
1631 * @see llvm::ConstantStruct::getAnon()
1633 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1634 LLVMValueRef *ConstantVals,
1635 unsigned Count, LLVMBool Packed);
1638 * Create a ConstantStruct in the global Context.
1640 * This is the same as LLVMConstStructInContext except it operates on the
1643 * @see LLVMConstStructInContext()
1645 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1649 * Create a ConstantArray from values.
1651 * @see llvm::ConstantArray::get()
1653 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1654 LLVMValueRef *ConstantVals, unsigned Length);
1657 * Create a non-anonymous ConstantStruct from values.
1659 * @see llvm::ConstantStruct::get()
1661 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1662 LLVMValueRef *ConstantVals,
1666 * Get an element at specified index as a constant.
1668 * @see ConstantDataSequential::getElementAsConstant()
1670 LLVMValueRef LLVMGetElementAsConstant(LLVMValueRef c, unsigned idx);
1673 * Create a ConstantVector from values.
1675 * @see llvm::ConstantVector::get()
1677 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1684 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1686 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1688 * @see llvm::ConstantExpr.
1692 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1693 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1694 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1695 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1696 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1697 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1698 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1699 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1700 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1701 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1702 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1703 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1704 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1705 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1706 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1707 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1708 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1709 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1710 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1711 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1712 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1713 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1714 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1715 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1716 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1717 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1718 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1719 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1720 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1721 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1722 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1723 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1724 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1725 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1726 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1727 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1728 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1729 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1730 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1731 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1732 LLVMValueRef *ConstantIndices,
1733 unsigned NumIndices);
1734 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1735 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1736 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1737 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1738 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1739 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1740 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1741 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1742 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1743 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1744 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1745 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1746 LLVMValueRef LLVMConstAddrSpaceCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1747 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1748 LLVMTypeRef ToType);
1749 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1750 LLVMTypeRef ToType);
1751 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1752 LLVMTypeRef ToType);
1753 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1754 LLVMTypeRef ToType);
1755 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1757 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1758 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1759 LLVMValueRef ConstantIfTrue,
1760 LLVMValueRef ConstantIfFalse);
1761 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1762 LLVMValueRef IndexConstant);
1763 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1764 LLVMValueRef ElementValueConstant,
1765 LLVMValueRef IndexConstant);
1766 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1767 LLVMValueRef VectorBConstant,
1768 LLVMValueRef MaskConstant);
1769 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1771 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1772 LLVMValueRef ElementValueConstant,
1773 unsigned *IdxList, unsigned NumIdx);
1774 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1775 const char *AsmString, const char *Constraints,
1776 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1777 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1784 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1786 * This group contains functions that operate on global values. Functions in
1787 * this group relate to functions in the llvm::GlobalValue class tree.
1789 * @see llvm::GlobalValue
1794 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1795 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1796 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1797 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1798 const char *LLVMGetSection(LLVMValueRef Global);
1799 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1800 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1801 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1802 LLVMDLLStorageClass LLVMGetDLLStorageClass(LLVMValueRef Global);
1803 void LLVMSetDLLStorageClass(LLVMValueRef Global, LLVMDLLStorageClass Class);
1804 LLVMBool LLVMHasUnnamedAddr(LLVMValueRef Global);
1805 void LLVMSetUnnamedAddr(LLVMValueRef Global, LLVMBool HasUnnamedAddr);
1808 * @defgroup LLVMCCoreValueWithAlignment Values with alignment
1810 * Functions in this group only apply to values with alignment, i.e.
1811 * global variables, load and store instructions.
1815 * Obtain the preferred alignment of the value.
1816 * @see llvm::AllocaInst::getAlignment()
1817 * @see llvm::LoadInst::getAlignment()
1818 * @see llvm::StoreInst::getAlignment()
1819 * @see llvm::GlobalValue::getAlignment()
1821 unsigned LLVMGetAlignment(LLVMValueRef V);
1824 * Set the preferred alignment of the value.
1825 * @see llvm::AllocaInst::setAlignment()
1826 * @see llvm::LoadInst::setAlignment()
1827 * @see llvm::StoreInst::setAlignment()
1828 * @see llvm::GlobalValue::setAlignment()
1830 void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes);
1837 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1839 * This group contains functions that operate on global variable values.
1841 * @see llvm::GlobalVariable
1845 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1846 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1848 unsigned AddressSpace);
1849 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1850 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1851 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1852 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1853 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1854 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1855 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1856 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1857 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1858 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1859 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1860 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1861 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1862 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1863 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1864 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1871 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1873 * This group contains function that operate on global alias values.
1875 * @see llvm::GlobalAlias
1879 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1887 * @defgroup LLVMCCoreValueFunction Function values
1889 * Functions in this group operate on LLVMValueRef instances that
1890 * correspond to llvm::Function instances.
1892 * @see llvm::Function
1898 * Remove a function from its containing module and deletes it.
1900 * @see llvm::Function::eraseFromParent()
1902 void LLVMDeleteFunction(LLVMValueRef Fn);
1905 * Obtain the personality function attached to the function.
1907 * @see llvm::Function::getPersonalityFn()
1909 LLVMValueRef LLVMGetPersonalityFn(LLVMValueRef Fn);
1912 * Set the personality function attached to the function.
1914 * @see llvm::Function::setPersonalityFn()
1916 void LLVMSetPersonalityFn(LLVMValueRef Fn, LLVMValueRef PersonalityFn);
1919 * Obtain the ID number from a function instance.
1921 * @see llvm::Function::getIntrinsicID()
1923 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1926 * Obtain the calling function of a function.
1928 * The returned value corresponds to the LLVMCallConv enumeration.
1930 * @see llvm::Function::getCallingConv()
1932 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1935 * Set the calling convention of a function.
1937 * @see llvm::Function::setCallingConv()
1939 * @param Fn Function to operate on
1940 * @param CC LLVMCallConv to set calling convention to
1942 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1945 * Obtain the name of the garbage collector to use during code
1948 * @see llvm::Function::getGC()
1950 const char *LLVMGetGC(LLVMValueRef Fn);
1953 * Define the garbage collector to use during code generation.
1955 * @see llvm::Function::setGC()
1957 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1960 * Add an attribute to a function.
1962 * @see llvm::Function::addAttribute()
1964 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1967 * Add a target-dependent attribute to a function
1968 * @see llvm::AttrBuilder::addAttribute()
1970 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1974 * Obtain an attribute from a function.
1976 * @see llvm::Function::getAttributes()
1978 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1981 * Remove an attribute from a function.
1983 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1986 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1988 * Functions in this group relate to arguments/parameters on functions.
1990 * Functions in this group expect LLVMValueRef instances that correspond
1991 * to llvm::Function instances.
1997 * Obtain the number of parameters in a function.
1999 * @see llvm::Function::arg_size()
2001 unsigned LLVMCountParams(LLVMValueRef Fn);
2004 * Obtain the parameters in a function.
2006 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
2007 * at least LLVMCountParams() long. This array will be filled with
2008 * LLVMValueRef instances which correspond to the parameters the
2009 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
2012 * @see llvm::Function::arg_begin()
2014 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
2017 * Obtain the parameter at the specified index.
2019 * Parameters are indexed from 0.
2021 * @see llvm::Function::arg_begin()
2023 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
2026 * Obtain the function to which this argument belongs.
2028 * Unlike other functions in this group, this one takes an LLVMValueRef
2029 * that corresponds to a llvm::Attribute.
2031 * The returned LLVMValueRef is the llvm::Function to which this
2034 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
2037 * Obtain the first parameter to a function.
2039 * @see llvm::Function::arg_begin()
2041 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
2044 * Obtain the last parameter to a function.
2046 * @see llvm::Function::arg_end()
2048 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
2051 * Obtain the next parameter to a function.
2053 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
2054 * actually a wrapped iterator) and obtains the next parameter from the
2055 * underlying iterator.
2057 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
2060 * Obtain the previous parameter to a function.
2062 * This is the opposite of LLVMGetNextParam().
2064 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
2067 * Add an attribute to a function argument.
2069 * @see llvm::Argument::addAttr()
2071 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
2074 * Remove an attribute from a function argument.
2076 * @see llvm::Argument::removeAttr()
2078 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
2081 * Get an attribute from a function argument.
2083 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
2086 * Set the alignment for a function parameter.
2088 * @see llvm::Argument::addAttr()
2089 * @see llvm::AttrBuilder::addAlignmentAttr()
2091 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
2110 * @defgroup LLVMCCoreValueMetadata Metadata
2116 * Obtain a MDString value from a context.
2118 * The returned instance corresponds to the llvm::MDString class.
2120 * The instance is specified by string data of a specified length. The
2121 * string content is copied, so the backing memory can be freed after
2122 * this function returns.
2124 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
2128 * Obtain a MDString value from the global context.
2130 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
2133 * Obtain a MDNode value from a context.
2135 * The returned value corresponds to the llvm::MDNode class.
2137 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
2141 * Obtain a MDNode value from the global context.
2143 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
2146 * Obtain the underlying string from a MDString value.
2148 * @param V Instance to obtain string from.
2149 * @param Len Memory address which will hold length of returned string.
2150 * @return String data in MDString.
2152 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
2155 * Obtain the number of operands from an MDNode value.
2157 * @param V MDNode to get number of operands from.
2158 * @return Number of operands of the MDNode.
2160 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
2163 * Obtain the given MDNode's operands.
2165 * The passed LLVMValueRef pointer should point to enough memory to hold all of
2166 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
2167 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
2168 * MDNode's operands.
2170 * @param V MDNode to get the operands from.
2171 * @param Dest Destination array for operands.
2173 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
2180 * @defgroup LLVMCCoreValueBasicBlock Basic Block
2182 * A basic block represents a single entry single exit section of code.
2183 * Basic blocks contain a list of instructions which form the body of
2186 * Basic blocks belong to functions. They have the type of label.
2188 * Basic blocks are themselves values. However, the C API models them as
2189 * LLVMBasicBlockRef.
2191 * @see llvm::BasicBlock
2197 * Convert a basic block instance to a value type.
2199 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
2202 * Determine whether an LLVMValueRef is itself a basic block.
2204 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
2207 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
2209 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
2212 * Obtain the function to which a basic block belongs.
2214 * @see llvm::BasicBlock::getParent()
2216 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2219 * Obtain the terminator instruction for a basic block.
2221 * If the basic block does not have a terminator (it is not well-formed
2222 * if it doesn't), then NULL is returned.
2224 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2226 * @see llvm::BasicBlock::getTerminator()
2228 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2231 * Obtain the number of basic blocks in a function.
2233 * @param Fn Function value to operate on.
2235 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2238 * Obtain all of the basic blocks in a function.
2240 * This operates on a function value. The BasicBlocks parameter is a
2241 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2242 * LLVMCountBasicBlocks() in length. This array is populated with
2243 * LLVMBasicBlockRef instances.
2245 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2248 * Obtain the first basic block in a function.
2250 * The returned basic block can be used as an iterator. You will likely
2251 * eventually call into LLVMGetNextBasicBlock() with it.
2253 * @see llvm::Function::begin()
2255 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2258 * Obtain the last basic block in a function.
2260 * @see llvm::Function::end()
2262 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2265 * Advance a basic block iterator.
2267 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2270 * Go backwards in a basic block iterator.
2272 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2275 * Obtain the basic block that corresponds to the entry point of a
2278 * @see llvm::Function::getEntryBlock()
2280 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2283 * Append a basic block to the end of a function.
2285 * @see llvm::BasicBlock::Create()
2287 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2292 * Append a basic block to the end of a function using the global
2295 * @see llvm::BasicBlock::Create()
2297 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2300 * Insert a basic block in a function before another basic block.
2302 * The function to add to is determined by the function of the
2303 * passed basic block.
2305 * @see llvm::BasicBlock::Create()
2307 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2308 LLVMBasicBlockRef BB,
2312 * Insert a basic block in a function using the global context.
2314 * @see llvm::BasicBlock::Create()
2316 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2320 * Remove a basic block from a function and delete it.
2322 * This deletes the basic block from its containing function and deletes
2323 * the basic block itself.
2325 * @see llvm::BasicBlock::eraseFromParent()
2327 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2330 * Remove a basic block from a function.
2332 * This deletes the basic block from its containing function but keep
2333 * the basic block alive.
2335 * @see llvm::BasicBlock::removeFromParent()
2337 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2340 * Move a basic block to before another one.
2342 * @see llvm::BasicBlock::moveBefore()
2344 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2347 * Move a basic block to after another one.
2349 * @see llvm::BasicBlock::moveAfter()
2351 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2354 * Obtain the first instruction in a basic block.
2356 * The returned LLVMValueRef corresponds to a llvm::Instruction
2359 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2362 * Obtain the last instruction in a basic block.
2364 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2366 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2373 * @defgroup LLVMCCoreValueInstruction Instructions
2375 * Functions in this group relate to the inspection and manipulation of
2376 * individual instructions.
2378 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2379 * class has a large number of descendents. llvm::Instruction is a
2380 * llvm::Value and in the C API, instructions are modeled by
2383 * This group also contains sub-groups which operate on specific
2384 * llvm::Instruction types, e.g. llvm::CallInst.
2390 * Determine whether an instruction has any metadata attached.
2392 int LLVMHasMetadata(LLVMValueRef Val);
2395 * Return metadata associated with an instruction value.
2397 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2400 * Set metadata associated with an instruction value.
2402 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2405 * Obtain the basic block to which an instruction belongs.
2407 * @see llvm::Instruction::getParent()
2409 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2412 * Obtain the instruction that occurs after the one specified.
2414 * The next instruction will be from the same basic block.
2416 * If this is the last instruction in a basic block, NULL will be
2419 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2422 * Obtain the instruction that occurred before this one.
2424 * If the instruction is the first instruction in a basic block, NULL
2427 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2430 * Remove and delete an instruction.
2432 * The instruction specified is removed from its containing building
2433 * block and then deleted.
2435 * @see llvm::Instruction::eraseFromParent()
2437 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2440 * Obtain the code opcode for an individual instruction.
2442 * @see llvm::Instruction::getOpCode()
2444 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2447 * Obtain the predicate of an instruction.
2449 * This is only valid for instructions that correspond to llvm::ICmpInst
2450 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2452 * @see llvm::ICmpInst::getPredicate()
2454 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2457 * Obtain the float predicate of an instruction.
2459 * This is only valid for instructions that correspond to llvm::FCmpInst
2460 * or llvm::ConstantExpr whose opcode is llvm::Instruction::FCmp.
2462 * @see llvm::FCmpInst::getPredicate()
2464 LLVMRealPredicate LLVMGetFCmpPredicate(LLVMValueRef Inst);
2467 * Create a copy of 'this' instruction that is identical in all ways
2468 * except the following:
2469 * * The instruction has no parent
2470 * * The instruction has no name
2472 * @see llvm::Instruction::clone()
2474 LLVMValueRef LLVMInstructionClone(LLVMValueRef Inst);
2477 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2479 * Functions in this group apply to instructions that refer to call
2480 * sites and invocations. These correspond to C++ types in the
2481 * llvm::CallInst class tree.
2487 * Set the calling convention for a call instruction.
2489 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2492 * @see llvm::CallInst::setCallingConv()
2493 * @see llvm::InvokeInst::setCallingConv()
2495 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2498 * Obtain the calling convention for a call instruction.
2500 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2503 * @see LLVMSetInstructionCallConv()
2505 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2508 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2509 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2511 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2515 * Obtain whether a call instruction is a tail call.
2517 * This only works on llvm::CallInst instructions.
2519 * @see llvm::CallInst::isTailCall()
2521 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2524 * Set whether a call instruction is a tail call.
2526 * This only works on llvm::CallInst instructions.
2528 * @see llvm::CallInst::setTailCall()
2530 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2537 * @defgroup LLVMCCoreValueInstructionTerminator Terminators
2539 * Functions in this group only apply to instructions that map to
2540 * llvm::TerminatorInst instances.
2546 * Return the number of successors that this terminator has.
2548 * @see llvm::TerminatorInst::getNumSuccessors
2550 unsigned LLVMGetNumSuccessors(LLVMValueRef Term);
2553 * Return the specified successor.
2555 * @see llvm::TerminatorInst::getSuccessor
2557 LLVMBasicBlockRef LLVMGetSuccessor(LLVMValueRef Term, unsigned i);
2560 * Update the specified successor to point at the provided block.
2562 * @see llvm::TerminatorInst::setSuccessor
2564 void LLVMSetSuccessor(LLVMValueRef Term, unsigned i, LLVMBasicBlockRef block);
2567 * Return if a branch is conditional.
2569 * This only works on llvm::BranchInst instructions.
2571 * @see llvm::BranchInst::isConditional
2573 LLVMBool LLVMIsConditional(LLVMValueRef Branch);
2576 * Return the condition of a branch instruction.
2578 * This only works on llvm::BranchInst instructions.
2580 * @see llvm::BranchInst::getCondition
2582 LLVMValueRef LLVMGetCondition(LLVMValueRef Branch);
2585 * Set the condition of a branch instruction.
2587 * This only works on llvm::BranchInst instructions.
2589 * @see llvm::BranchInst::setCondition
2591 void LLVMSetCondition(LLVMValueRef Branch, LLVMValueRef Cond);
2594 * Obtain the default destination basic block of a switch instruction.
2596 * This only works on llvm::SwitchInst instructions.
2598 * @see llvm::SwitchInst::getDefaultDest()
2600 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2607 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2609 * Functions in this group only apply to instructions that map to
2610 * llvm::PHINode instances.
2616 * Add an incoming value to the end of a PHI list.
2618 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2619 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2622 * Obtain the number of incoming basic blocks to a PHI node.
2624 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2627 * Obtain an incoming value to a PHI node as an LLVMValueRef.
2629 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2632 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2634 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2649 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2651 * An instruction builder represents a point within a basic block and is
2652 * the exclusive means of building instructions using the C interface.
2657 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2658 LLVMBuilderRef LLVMCreateBuilder(void);
2659 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2660 LLVMValueRef Instr);
2661 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2662 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2663 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2664 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2665 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2666 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2668 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2671 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2672 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2673 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2676 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2677 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2678 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2680 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2681 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2682 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2683 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2684 LLVMBasicBlockRef Else, unsigned NumCases);
2685 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2687 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2688 LLVMValueRef *Args, unsigned NumArgs,
2689 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2691 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2692 LLVMValueRef PersFn, unsigned NumClauses,
2694 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2695 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2697 /* Add a case to the switch instruction */
2698 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2699 LLVMBasicBlockRef Dest);
2701 /* Add a destination to the indirectbr instruction */
2702 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2704 /* Add a catch or filter clause to the landingpad instruction */
2705 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2707 /* Set the 'cleanup' flag in the landingpad instruction */
2708 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2711 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2713 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2715 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2717 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2719 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2721 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2723 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2725 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2727 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2729 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2731 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2733 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2735 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2737 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2739 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2741 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2743 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2745 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2747 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2749 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2751 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2753 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2755 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2757 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2759 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2761 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2762 LLVMValueRef LHS, LLVMValueRef RHS,
2764 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2765 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2767 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2769 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2770 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2773 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2774 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2775 LLVMValueRef Val, const char *Name);
2776 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2777 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2778 LLVMValueRef Val, const char *Name);
2779 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2780 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2782 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2783 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2784 LLVMValueRef *Indices, unsigned NumIndices,
2786 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2787 LLVMValueRef *Indices, unsigned NumIndices,
2789 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2790 unsigned Idx, const char *Name);
2791 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2793 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2795 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2796 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2797 LLVMAtomicOrdering LLVMGetOrdering(LLVMValueRef MemoryAccessInst);
2798 void LLVMSetOrdering(LLVMValueRef MemoryAccessInst, LLVMAtomicOrdering Ordering);
2801 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2802 LLVMTypeRef DestTy, const char *Name);
2803 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2804 LLVMTypeRef DestTy, const char *Name);
2805 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2806 LLVMTypeRef DestTy, const char *Name);
2807 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2808 LLVMTypeRef DestTy, const char *Name);
2809 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2810 LLVMTypeRef DestTy, const char *Name);
2811 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2812 LLVMTypeRef DestTy, const char *Name);
2813 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2814 LLVMTypeRef DestTy, const char *Name);
2815 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2816 LLVMTypeRef DestTy, const char *Name);
2817 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2818 LLVMTypeRef DestTy, const char *Name);
2819 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2820 LLVMTypeRef DestTy, const char *Name);
2821 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2822 LLVMTypeRef DestTy, const char *Name);
2823 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2824 LLVMTypeRef DestTy, const char *Name);
2825 LLVMValueRef LLVMBuildAddrSpaceCast(LLVMBuilderRef, LLVMValueRef Val,
2826 LLVMTypeRef DestTy, const char *Name);
2827 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2828 LLVMTypeRef DestTy, const char *Name);
2829 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2830 LLVMTypeRef DestTy, const char *Name);
2831 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2832 LLVMTypeRef DestTy, const char *Name);
2833 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2834 LLVMTypeRef DestTy, const char *Name);
2835 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2836 LLVMTypeRef DestTy, const char *Name);
2837 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2838 LLVMTypeRef DestTy, const char *Name);
2839 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2840 LLVMTypeRef DestTy, const char *Name);
2843 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2844 LLVMValueRef LHS, LLVMValueRef RHS,
2846 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2847 LLVMValueRef LHS, LLVMValueRef RHS,
2850 /* Miscellaneous instructions */
2851 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2852 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2853 LLVMValueRef *Args, unsigned NumArgs,
2855 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2856 LLVMValueRef Then, LLVMValueRef Else,
2858 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2860 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2861 LLVMValueRef Index, const char *Name);
2862 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2863 LLVMValueRef EltVal, LLVMValueRef Index,
2865 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2866 LLVMValueRef V2, LLVMValueRef Mask,
2868 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2869 unsigned Index, const char *Name);
2870 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2871 LLVMValueRef EltVal, unsigned Index,
2874 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2876 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2878 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2879 LLVMValueRef RHS, const char *Name);
2880 LLVMValueRef LLVMBuildFence(LLVMBuilderRef B, LLVMAtomicOrdering ordering,
2881 LLVMBool singleThread, const char *Name);
2882 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B, LLVMAtomicRMWBinOp op,
2883 LLVMValueRef PTR, LLVMValueRef Val,
2884 LLVMAtomicOrdering ordering,
2885 LLVMBool singleThread);
2892 * @defgroup LLVMCCoreModuleProvider Module Providers
2898 * Changes the type of M so it can be passed to FunctionPassManagers and the
2899 * JIT. They take ModuleProviders for historical reasons.
2901 LLVMModuleProviderRef
2902 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2905 * Destroys the module M.
2907 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2914 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2919 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2920 LLVMMemoryBufferRef *OutMemBuf,
2922 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2924 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2925 size_t InputDataLength,
2926 const char *BufferName,
2927 LLVMBool RequiresNullTerminator);
2928 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2929 size_t InputDataLength,
2930 const char *BufferName);
2931 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2932 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2933 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2940 * @defgroup LLVMCCorePassRegistry Pass Registry
2945 /** Return the global pass registry, for use with initialization functions.
2946 @see llvm::PassRegistry::getPassRegistry */
2947 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2954 * @defgroup LLVMCCorePassManagers Pass Managers
2959 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2960 suitable for link-time optimization and whole-module transformations.
2961 @see llvm::PassManager::PassManager */
2962 LLVMPassManagerRef LLVMCreatePassManager(void);
2964 /** Constructs a new function-by-function pass pipeline over the module
2965 provider. It does not take ownership of the module provider. This type of
2966 pipeline is suitable for code generation and JIT compilation tasks.
2967 @see llvm::FunctionPassManager::FunctionPassManager */
2968 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2970 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2971 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2973 /** Initializes, executes on the provided module, and finalizes all of the
2974 passes scheduled in the pass manager. Returns 1 if any of the passes
2975 modified the module, 0 otherwise.
2976 @see llvm::PassManager::run(Module&) */
2977 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2979 /** Initializes all of the function passes scheduled in the function pass
2980 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2981 @see llvm::FunctionPassManager::doInitialization */
2982 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2984 /** Executes all of the function passes scheduled in the function pass manager
2985 on the provided function. Returns 1 if any of the passes modified the
2986 function, false otherwise.
2987 @see llvm::FunctionPassManager::run(Function&) */
2988 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2990 /** Finalizes all of the function passes scheduled in in the function pass
2991 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2992 @see llvm::FunctionPassManager::doFinalization */
2993 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2995 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2996 the module provider.
2997 @see llvm::PassManagerBase::~PassManagerBase. */
2998 void LLVMDisposePassManager(LLVMPassManagerRef PM);
3005 * @defgroup LLVMCCoreThreading Threading
3007 * Handle the structures needed to make LLVM safe for multithreading.
3012 /** Deprecated: Multi-threading can only be enabled/disabled with the compile
3013 time define LLVM_ENABLE_THREADS. This function always returns
3014 LLVMIsMultithreaded(). */
3015 LLVMBool LLVMStartMultithreaded(void);
3017 /** Deprecated: Multi-threading can only be enabled/disabled with the compile
3018 time define LLVM_ENABLE_THREADS. */
3019 void LLVMStopMultithreaded(void);
3021 /** Check whether LLVM is executing in thread-safe mode or not.
3022 @see llvm::llvm_is_multithreaded */
3023 LLVMBool LLVMIsMultithreaded(void);
3041 #endif /* LLVM_C_CORE_H */