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
263 LLVMVoidTypeKind, /**< type with no size */
264 LLVMHalfTypeKind, /**< 16 bit floating point type */
265 LLVMFloatTypeKind, /**< 32 bit floating point type */
266 LLVMDoubleTypeKind, /**< 64 bit floating point type */
267 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
268 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
269 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
270 LLVMLabelTypeKind, /**< Labels */
271 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
272 LLVMFunctionTypeKind, /**< Functions */
273 LLVMStructTypeKind, /**< Structures */
274 LLVMArrayTypeKind, /**< Arrays */
275 LLVMPointerTypeKind, /**< Pointers */
276 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
277 LLVMMetadataTypeKind, /**< Metadata */
278 LLVMX86_MMXTypeKind, /**< X86 MMX */
279 LLVMTokenTypeKind /**< Tokens */
283 LLVMExternalLinkage, /**< Externally visible function */
284 LLVMAvailableExternallyLinkage,
285 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
286 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
288 LLVMLinkOnceODRAutoHideLinkage, /**< Obsolete */
289 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
290 LLVMWeakODRLinkage, /**< Same, but only replaced by something
292 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
293 LLVMInternalLinkage, /**< Rename collisions when linking (static
295 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
296 LLVMDLLImportLinkage, /**< Obsolete */
297 LLVMDLLExportLinkage, /**< Obsolete */
298 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
299 LLVMGhostLinkage, /**< Obsolete */
300 LLVMCommonLinkage, /**< Tentative definitions */
301 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
302 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */
306 LLVMDefaultVisibility, /**< The GV is visible */
307 LLVMHiddenVisibility, /**< The GV is hidden */
308 LLVMProtectedVisibility /**< The GV is protected */
312 LLVMDefaultStorageClass = 0,
313 LLVMDLLImportStorageClass = 1, /**< Function to be imported from DLL. */
314 LLVMDLLExportStorageClass = 2 /**< Function to be accessible from DLL. */
315 } LLVMDLLStorageClass;
319 LLVMFastCallConv = 8,
320 LLVMColdCallConv = 9,
321 LLVMWebKitJSCallConv = 12,
322 LLVMAnyRegCallConv = 13,
323 LLVMX86StdcallCallConv = 64,
324 LLVMX86FastcallCallConv = 65
328 LLVMIntEQ = 32, /**< equal */
329 LLVMIntNE, /**< not equal */
330 LLVMIntUGT, /**< unsigned greater than */
331 LLVMIntUGE, /**< unsigned greater or equal */
332 LLVMIntULT, /**< unsigned less than */
333 LLVMIntULE, /**< unsigned less or equal */
334 LLVMIntSGT, /**< signed greater than */
335 LLVMIntSGE, /**< signed greater or equal */
336 LLVMIntSLT, /**< signed less than */
337 LLVMIntSLE /**< signed less or equal */
341 LLVMRealPredicateFalse, /**< Always false (always folded) */
342 LLVMRealOEQ, /**< True if ordered and equal */
343 LLVMRealOGT, /**< True if ordered and greater than */
344 LLVMRealOGE, /**< True if ordered and greater than or equal */
345 LLVMRealOLT, /**< True if ordered and less than */
346 LLVMRealOLE, /**< True if ordered and less than or equal */
347 LLVMRealONE, /**< True if ordered and operands are unequal */
348 LLVMRealORD, /**< True if ordered (no nans) */
349 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
350 LLVMRealUEQ, /**< True if unordered or equal */
351 LLVMRealUGT, /**< True if unordered or greater than */
352 LLVMRealUGE, /**< True if unordered, greater than, or equal */
353 LLVMRealULT, /**< True if unordered or less than */
354 LLVMRealULE, /**< True if unordered, less than, or equal */
355 LLVMRealUNE, /**< True if unordered or not equal */
356 LLVMRealPredicateTrue /**< Always true (always folded) */
360 LLVMLandingPadCatch, /**< A catch clause */
361 LLVMLandingPadFilter /**< A filter clause */
362 } LLVMLandingPadClauseTy;
365 LLVMNotThreadLocal = 0,
366 LLVMGeneralDynamicTLSModel,
367 LLVMLocalDynamicTLSModel,
368 LLVMInitialExecTLSModel,
369 LLVMLocalExecTLSModel
370 } LLVMThreadLocalMode;
373 LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */
374 LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees
375 somewhat sane results, lock free. */
376 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the
377 operations affecting a specific address,
378 a consistent ordering exists */
379 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort
380 necessary to acquire a lock to access other
381 memory with normal loads and stores. */
382 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with
383 a barrier of the sort necessary to release
385 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a
386 Release barrier (for fences and
387 operations which both read and write
389 LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics
390 for loads and Release
391 semantics for stores.
392 Additionally, it guarantees
393 that a total ordering exists
395 SequentiallyConsistent
397 } LLVMAtomicOrdering;
400 LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */
401 LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */
402 LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */
403 LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */
404 LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */
405 LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */
406 LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */
407 LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the
408 original using a signed comparison and return
410 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the
411 original using a signed comparison and return
413 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the
414 original using an unsigned comparison and return
416 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the
417 original using an unsigned comparison and return
419 } LLVMAtomicRMWBinOp;
426 } LLVMDiagnosticSeverity;
432 void LLVMInitializeCore(LLVMPassRegistryRef R);
434 /** Deallocate and destroy all ManagedStatic variables.
435 @see llvm::llvm_shutdown
436 @see ManagedStatic */
437 void LLVMShutdown(void);
440 /*===-- Error handling ----------------------------------------------------===*/
442 char *LLVMCreateMessage(const char *Message);
443 void LLVMDisposeMessage(char *Message);
445 typedef void (*LLVMFatalErrorHandler)(const char *Reason);
448 * Install a fatal error handler. By default, if LLVM detects a fatal error, it
449 * will call exit(1). This may not be appropriate in many contexts. For example,
450 * doing exit(1) will bypass many crash reporting/tracing system tools. This
451 * function allows you to install a callback that will be invoked prior to the
454 void LLVMInstallFatalErrorHandler(LLVMFatalErrorHandler Handler);
457 * Reset the fatal error handler. This resets LLVM's fatal error handling
458 * behavior to the default.
460 void LLVMResetFatalErrorHandler(void);
463 * Enable LLVM's built-in stack trace code. This intercepts the OS's crash
464 * signals and prints which component of LLVM you were in at the time if the
467 void LLVMEnablePrettyStackTrace(void);
470 * @defgroup LLVMCCoreContext Contexts
472 * Contexts are execution states for the core LLVM IR system.
474 * Most types are tied to a context instance. Multiple contexts can
475 * exist simultaneously. A single context is not thread safe. However,
476 * different contexts can execute on different threads simultaneously.
481 typedef void (*LLVMDiagnosticHandler)(LLVMDiagnosticInfoRef, void *);
482 typedef void (*LLVMYieldCallback)(LLVMContextRef, void *);
485 * Create a new context.
487 * Every call to this function should be paired with a call to
488 * LLVMContextDispose() or the context will leak memory.
490 LLVMContextRef LLVMContextCreate(void);
493 * Obtain the global context instance.
495 LLVMContextRef LLVMGetGlobalContext(void);
498 * Set the diagnostic handler for this context.
500 void LLVMContextSetDiagnosticHandler(LLVMContextRef C,
501 LLVMDiagnosticHandler Handler,
502 void *DiagnosticContext);
505 * Set the yield callback function for this context.
507 * @see LLVMContext::setYieldCallback()
509 void LLVMContextSetYieldCallback(LLVMContextRef C, LLVMYieldCallback Callback,
513 * Destroy a context instance.
515 * This should be called for every call to LLVMContextCreate() or memory
518 void LLVMContextDispose(LLVMContextRef C);
521 * Return a string representation of the DiagnosticInfo. Use
522 * LLVMDisposeMessage to free the string.
524 * @see DiagnosticInfo::print()
526 char *LLVMGetDiagInfoDescription(LLVMDiagnosticInfoRef DI);
529 * Return an enum LLVMDiagnosticSeverity.
531 * @see DiagnosticInfo::getSeverity()
533 LLVMDiagnosticSeverity LLVMGetDiagInfoSeverity(LLVMDiagnosticInfoRef DI);
535 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
537 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
544 * @defgroup LLVMCCoreModule Modules
546 * Modules represent the top-level structure in an LLVM program. An LLVM
547 * module is effectively a translation unit or a collection of
548 * translation units merged together.
554 * Create a new, empty module in the global context.
556 * This is equivalent to calling LLVMModuleCreateWithNameInContext with
557 * LLVMGetGlobalContext() as the context parameter.
559 * Every invocation should be paired with LLVMDisposeModule() or memory
562 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
565 * Create a new, empty module in a specific context.
567 * Every invocation should be paired with LLVMDisposeModule() or memory
570 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
573 * Return an exact copy of the specified module.
575 LLVMModuleRef LLVMCloneModule(LLVMModuleRef M);
578 * Destroy a module instance.
580 * This must be called for every created module or memory will be
583 void LLVMDisposeModule(LLVMModuleRef M);
586 * Obtain the data layout for a module.
588 * @see Module::getDataLayout()
590 const char *LLVMGetDataLayout(LLVMModuleRef M);
593 * Set the data layout for a module.
595 * @see Module::setDataLayout()
597 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
600 * Obtain the target triple for a module.
602 * @see Module::getTargetTriple()
604 const char *LLVMGetTarget(LLVMModuleRef M);
607 * Set the target triple for a module.
609 * @see Module::setTargetTriple()
611 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
614 * Dump a representation of a module to stderr.
616 * @see Module::dump()
618 void LLVMDumpModule(LLVMModuleRef M);
621 * Print a representation of a module to a file. The ErrorMessage needs to be
622 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.
624 * @see Module::print()
626 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename,
627 char **ErrorMessage);
630 * Return a string representation of the module. Use
631 * LLVMDisposeMessage to free the string.
633 * @see Module::print()
635 char *LLVMPrintModuleToString(LLVMModuleRef M);
638 * Set inline assembly for a module.
640 * @see Module::setModuleInlineAsm()
642 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
645 * Obtain the context to which this module is associated.
647 * @see Module::getContext()
649 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
652 * Obtain a Type from a module by its registered name.
654 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
657 * Obtain the number of operands for named metadata in a module.
659 * @see llvm::Module::getNamedMetadata()
661 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
664 * Obtain the named metadata operands for a module.
666 * The passed LLVMValueRef pointer should refer to an array of
667 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This
668 * array will be populated with the LLVMValueRef instances. Each
669 * instance corresponds to a llvm::MDNode.
671 * @see llvm::Module::getNamedMetadata()
672 * @see llvm::MDNode::getOperand()
674 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
677 * Add an operand to named metadata.
679 * @see llvm::Module::getNamedMetadata()
680 * @see llvm::MDNode::addOperand()
682 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name,
686 * Add a function to a module under a specified name.
688 * @see llvm::Function::Create()
690 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
691 LLVMTypeRef FunctionTy);
694 * Obtain a Function value from a Module by its name.
696 * The returned value corresponds to a llvm::Function value.
698 * @see llvm::Module::getFunction()
700 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
703 * Obtain an iterator to the first Function in a Module.
705 * @see llvm::Module::begin()
707 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
710 * Obtain an iterator to the last Function in a Module.
712 * @see llvm::Module::end()
714 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
717 * Advance a Function iterator to the next Function.
719 * Returns NULL if the iterator was already at the end and there are no more
722 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
725 * Decrement a Function iterator to the previous Function.
727 * Returns NULL if the iterator was already at the beginning and there are
728 * no previous functions.
730 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
737 * @defgroup LLVMCCoreType Types
739 * Types represent the type of a value.
741 * Types are associated with a context instance. The context internally
742 * deduplicates types so there is only 1 instance of a specific type
743 * alive at a time. In other words, a unique type is shared among all
744 * consumers within a context.
746 * A Type in the C API corresponds to llvm::Type.
748 * Types have the following hierarchy:
766 * Obtain the enumerated type of a Type instance.
768 * @see llvm::Type:getTypeID()
770 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
773 * Whether the type has a known size.
775 * Things that don't have a size are abstract types, labels, and void.a
777 * @see llvm::Type::isSized()
779 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
782 * Obtain the context to which this type instance is associated.
784 * @see llvm::Type::getContext()
786 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
789 * Dump a representation of a type to stderr.
791 * @see llvm::Type::dump()
793 void LLVMDumpType(LLVMTypeRef Val);
796 * Return a string representation of the type. Use
797 * LLVMDisposeMessage to free the string.
799 * @see llvm::Type::print()
801 char *LLVMPrintTypeToString(LLVMTypeRef Val);
804 * @defgroup LLVMCCoreTypeInt Integer Types
806 * Functions in this section operate on integer types.
812 * Obtain an integer type from a context with specified bit width.
814 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
815 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
816 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
817 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
818 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
819 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
822 * Obtain an integer type from the global context with a specified bit
825 LLVMTypeRef LLVMInt1Type(void);
826 LLVMTypeRef LLVMInt8Type(void);
827 LLVMTypeRef LLVMInt16Type(void);
828 LLVMTypeRef LLVMInt32Type(void);
829 LLVMTypeRef LLVMInt64Type(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);
1035 * @defgroup LLVMCCoreTypeSequential Sequential Types
1037 * Sequential types represents "arrays" of types. This is a super class
1038 * for array, vector, and pointer types.
1044 * Obtain the type of elements within a sequential type.
1046 * This works on array, vector, and pointer types.
1048 * @see llvm::SequentialType::getElementType()
1050 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
1053 * Create a fixed size array type that refers to a specific type.
1055 * The created type will exist in the context that its element type
1058 * @see llvm::ArrayType::get()
1060 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
1063 * Obtain the length of an array type.
1065 * This only works on types that represent arrays.
1067 * @see llvm::ArrayType::getNumElements()
1069 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
1072 * Create a pointer type that points to a defined type.
1074 * The created type will exist in the context that its pointee type
1077 * @see llvm::PointerType::get()
1079 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
1082 * Obtain the address space of a pointer type.
1084 * This only works on types that represent pointers.
1086 * @see llvm::PointerType::getAddressSpace()
1088 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
1091 * Create a vector type that contains a defined type and has a specific
1092 * number of elements.
1094 * The created type will exist in the context thats its element type
1097 * @see llvm::VectorType::get()
1099 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
1102 * Obtain the number of elements in a vector type.
1104 * This only works on types that represent vectors.
1106 * @see llvm::VectorType::getNumElements()
1108 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
1115 * @defgroup LLVMCCoreTypeOther Other Types
1121 * Create a void type in a context.
1123 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
1126 * Create a label type in a context.
1128 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
1131 * Create a X86 MMX type in a context.
1133 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
1136 * These are similar to the above functions except they operate on the
1139 LLVMTypeRef LLVMVoidType(void);
1140 LLVMTypeRef LLVMLabelType(void);
1141 LLVMTypeRef LLVMX86MMXType(void);
1152 * @defgroup LLVMCCoreValues Values
1154 * The bulk of LLVM's object model consists of values, which comprise a very
1155 * rich type hierarchy.
1157 * LLVMValueRef essentially represents llvm::Value. There is a rich
1158 * hierarchy of classes within this type. Depending on the instance
1159 * obtained, not all APIs are available.
1161 * Callers can determine the type of an LLVMValueRef by calling the
1162 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These
1163 * functions are defined by a macro, so it isn't obvious which are
1164 * available by looking at the Doxygen source code. Instead, look at the
1165 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list
1166 * of value names given. These value names also correspond to classes in
1167 * the llvm::Value hierarchy.
1172 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
1178 macro(BlockAddress) \
1179 macro(ConstantAggregateZero) \
1180 macro(ConstantArray) \
1181 macro(ConstantDataSequential) \
1182 macro(ConstantDataArray) \
1183 macro(ConstantDataVector) \
1184 macro(ConstantExpr) \
1186 macro(ConstantInt) \
1187 macro(ConstantPointerNull) \
1188 macro(ConstantStruct) \
1189 macro(ConstantVector) \
1190 macro(GlobalValue) \
1191 macro(GlobalAlias) \
1192 macro(GlobalObject) \
1194 macro(GlobalVariable) \
1196 macro(Instruction) \
1197 macro(BinaryOperator) \
1199 macro(IntrinsicInst) \
1200 macro(DbgInfoIntrinsic) \
1201 macro(DbgDeclareInst) \
1202 macro(MemIntrinsic) \
1204 macro(MemMoveInst) \
1209 macro(ExtractElementInst) \
1210 macro(GetElementPtrInst) \
1211 macro(InsertElementInst) \
1212 macro(InsertValueInst) \
1213 macro(LandingPadInst) \
1214 macro(CleanupPadInst) \
1217 macro(ShuffleVectorInst) \
1219 macro(TerminatorInst) \
1221 macro(IndirectBrInst) \
1225 macro(UnreachableInst) \
1227 macro(CleanupReturnInst) \
1228 macro(CatchReturnInst) \
1229 macro(CatchPadInst) \
1230 macro(TerminatePadInst) \
1231 macro(CatchEndPadInst) \
1232 macro(CleanupEndPadInst) \
1233 macro(UnaryInstruction) \
1236 macro(AddrSpaceCastInst) \
1237 macro(BitCastInst) \
1241 macro(FPTruncInst) \
1242 macro(IntToPtrInst) \
1243 macro(PtrToIntInst) \
1249 macro(ExtractValueInst) \
1254 * @defgroup LLVMCCoreValueGeneral General APIs
1256 * Functions in this section work on all LLVMValueRef instances,
1257 * regardless of their sub-type. They correspond to functions available
1264 * Obtain the type of a value.
1266 * @see llvm::Value::getType()
1268 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
1271 * Obtain the string name of a value.
1273 * @see llvm::Value::getName()
1275 const char *LLVMGetValueName(LLVMValueRef Val);
1278 * Set the string name of a value.
1280 * @see llvm::Value::setName()
1282 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
1285 * Dump a representation of a value to stderr.
1287 * @see llvm::Value::dump()
1289 void LLVMDumpValue(LLVMValueRef Val);
1292 * Return a string representation of the value. Use
1293 * LLVMDisposeMessage to free the string.
1295 * @see llvm::Value::print()
1297 char *LLVMPrintValueToString(LLVMValueRef Val);
1300 * Replace all uses of a value with another one.
1302 * @see llvm::Value::replaceAllUsesWith()
1304 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
1307 * Determine whether the specified constant instance is constant.
1309 LLVMBool LLVMIsConstant(LLVMValueRef Val);
1312 * Determine whether a value instance is undefined.
1314 LLVMBool LLVMIsUndef(LLVMValueRef Val);
1317 * Convert value instances between types.
1319 * Internally, an LLVMValueRef is "pinned" to a specific type. This
1320 * series of functions allows you to cast an instance to a specific
1323 * If the cast is not valid for the specified type, NULL is returned.
1325 * @see llvm::dyn_cast_or_null<>
1327 #define LLVM_DECLARE_VALUE_CAST(name) \
1328 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
1329 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
1331 LLVMValueRef LLVMIsAMDNode(LLVMValueRef Val);
1332 LLVMValueRef LLVMIsAMDString(LLVMValueRef Val);
1339 * @defgroup LLVMCCoreValueUses Usage
1341 * This module defines functions that allow you to inspect the uses of a
1344 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance.
1345 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a
1346 * llvm::User and llvm::Value.
1352 * Obtain the first use of a value.
1354 * Uses are obtained in an iterator fashion. First, call this function
1355 * to obtain a reference to the first use. Then, call LLVMGetNextUse()
1356 * on that instance and all subsequently obtained instances until
1357 * LLVMGetNextUse() returns NULL.
1359 * @see llvm::Value::use_begin()
1361 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
1364 * Obtain the next use of a value.
1366 * This effectively advances the iterator. It returns NULL if you are on
1367 * the final use and no more are available.
1369 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
1372 * Obtain the user value for a user.
1374 * The returned value corresponds to a llvm::User type.
1376 * @see llvm::Use::getUser()
1378 LLVMValueRef LLVMGetUser(LLVMUseRef U);
1381 * Obtain the value this use corresponds to.
1383 * @see llvm::Use::get().
1385 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
1392 * @defgroup LLVMCCoreValueUser User value
1394 * Function in this group pertain to LLVMValueRef instances that descent
1395 * from llvm::User. This includes constants, instructions, and
1402 * Obtain an operand at a specific index in a llvm::User value.
1404 * @see llvm::User::getOperand()
1406 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
1409 * Obtain the use of an operand at a specific index in a llvm::User value.
1411 * @see llvm::User::getOperandUse()
1413 LLVMUseRef LLVMGetOperandUse(LLVMValueRef Val, unsigned Index);
1416 * Set an operand at a specific index in a llvm::User value.
1418 * @see llvm::User::setOperand()
1420 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
1423 * Obtain the number of operands in a llvm::User value.
1425 * @see llvm::User::getNumOperands()
1427 int LLVMGetNumOperands(LLVMValueRef Val);
1434 * @defgroup LLVMCCoreValueConstant Constants
1436 * This section contains APIs for interacting with LLVMValueRef that
1437 * correspond to llvm::Constant instances.
1439 * These functions will work for any LLVMValueRef in the llvm::Constant
1446 * Obtain a constant value referring to the null instance of a type.
1448 * @see llvm::Constant::getNullValue()
1450 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
1453 * Obtain a constant value referring to the instance of a type
1454 * consisting of all ones.
1456 * This is only valid for integer types.
1458 * @see llvm::Constant::getAllOnesValue()
1460 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty);
1463 * Obtain a constant value referring to an undefined value of a type.
1465 * @see llvm::UndefValue::get()
1467 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
1470 * Determine whether a value instance is null.
1472 * @see llvm::Constant::isNullValue()
1474 LLVMBool LLVMIsNull(LLVMValueRef Val);
1477 * Obtain a constant that is a constant pointer pointing to NULL for a
1480 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
1483 * @defgroup LLVMCCoreValueConstantScalar Scalar constants
1485 * Functions in this group model LLVMValueRef instances that correspond
1486 * to constants referring to scalar types.
1488 * For integer types, the LLVMTypeRef parameter should correspond to a
1489 * llvm::IntegerType instance and the returned LLVMValueRef will
1490 * correspond to a llvm::ConstantInt.
1492 * For floating point types, the LLVMTypeRef returned corresponds to a
1499 * Obtain a constant value for an integer type.
1501 * The returned value corresponds to a llvm::ConstantInt.
1503 * @see llvm::ConstantInt::get()
1505 * @param IntTy Integer type to obtain value of.
1506 * @param N The value the returned instance should refer to.
1507 * @param SignExtend Whether to sign extend the produced value.
1509 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
1510 LLVMBool SignExtend);
1513 * Obtain a constant value for an integer of arbitrary precision.
1515 * @see llvm::ConstantInt::get()
1517 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
1519 const uint64_t Words[]);
1522 * Obtain a constant value for an integer parsed from a string.
1524 * A similar API, LLVMConstIntOfStringAndSize is also available. If the
1525 * string's length is available, it is preferred to call that function
1528 * @see llvm::ConstantInt::get()
1530 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
1534 * Obtain a constant value for an integer parsed from a string with
1537 * @see llvm::ConstantInt::get()
1539 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
1540 unsigned SLen, uint8_t Radix);
1543 * Obtain a constant value referring to a double floating point value.
1545 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
1548 * Obtain a constant for a floating point value parsed from a string.
1550 * A similar API, LLVMConstRealOfStringAndSize is also available. It
1551 * should be used if the input string's length is known.
1553 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
1556 * Obtain a constant for a floating point value parsed from a string.
1558 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
1562 * Obtain the zero extended value for an integer constant value.
1564 * @see llvm::ConstantInt::getZExtValue()
1566 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
1569 * Obtain the sign extended value for an integer constant value.
1571 * @see llvm::ConstantInt::getSExtValue()
1573 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
1576 * Obtain the double value for an floating point constant value.
1577 * losesInfo indicates if some precision was lost in the conversion.
1579 * @see llvm::ConstantFP::getDoubleValue
1581 double LLVMConstRealGetDouble(LLVMValueRef ConstantVal, LLVMBool *losesInfo);
1588 * @defgroup LLVMCCoreValueConstantComposite Composite Constants
1590 * Functions in this group operate on composite constants.
1596 * Create a ConstantDataSequential and initialize it with a string.
1598 * @see llvm::ConstantDataArray::getString()
1600 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
1601 unsigned Length, LLVMBool DontNullTerminate);
1604 * Create a ConstantDataSequential with string content in the global context.
1606 * This is the same as LLVMConstStringInContext except it operates on the
1609 * @see LLVMConstStringInContext()
1610 * @see llvm::ConstantDataArray::getString()
1612 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
1613 LLVMBool DontNullTerminate);
1616 * Returns true if the specified constant is an array of i8.
1618 * @see ConstantDataSequential::getAsString()
1620 LLVMBool LLVMIsConstantString(LLVMValueRef c);
1623 * Get the given constant data sequential as a string.
1625 * @see ConstantDataSequential::getAsString()
1627 const char *LLVMGetAsString(LLVMValueRef c, size_t* out);
1630 * Create an anonymous ConstantStruct with the specified values.
1632 * @see llvm::ConstantStruct::getAnon()
1634 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
1635 LLVMValueRef *ConstantVals,
1636 unsigned Count, LLVMBool Packed);
1639 * Create a ConstantStruct in the global Context.
1641 * This is the same as LLVMConstStructInContext except it operates on the
1644 * @see LLVMConstStructInContext()
1646 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
1650 * Create a ConstantArray from values.
1652 * @see llvm::ConstantArray::get()
1654 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
1655 LLVMValueRef *ConstantVals, unsigned Length);
1658 * Create a non-anonymous ConstantStruct from values.
1660 * @see llvm::ConstantStruct::get()
1662 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
1663 LLVMValueRef *ConstantVals,
1667 * Get an element at specified index as a constant.
1669 * @see ConstantDataSequential::getElementAsConstant()
1671 LLVMValueRef LLVMGetElementAsConstant(LLVMValueRef c, unsigned idx);
1674 * Create a ConstantVector from values.
1676 * @see llvm::ConstantVector::get()
1678 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
1685 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions
1687 * Functions in this group correspond to APIs on llvm::ConstantExpr.
1689 * @see llvm::ConstantExpr.
1693 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
1694 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
1695 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
1696 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
1697 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
1698 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
1699 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
1700 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
1701 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1702 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1703 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1704 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1705 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1706 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1707 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1708 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1709 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1710 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1711 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1712 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1713 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1714 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1715 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1716 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1717 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1718 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1719 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1720 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1721 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1722 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1723 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
1724 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1725 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
1726 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1727 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1728 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1729 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
1730 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
1731 LLVMValueRef *ConstantIndices, unsigned NumIndices);
1732 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
1733 LLVMValueRef *ConstantIndices,
1734 unsigned NumIndices);
1735 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1736 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1737 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1738 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1739 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1740 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1741 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1742 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1743 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1744 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1745 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1746 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1747 LLVMValueRef LLVMConstAddrSpaceCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1748 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
1749 LLVMTypeRef ToType);
1750 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
1751 LLVMTypeRef ToType);
1752 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
1753 LLVMTypeRef ToType);
1754 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
1755 LLVMTypeRef ToType);
1756 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
1758 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
1759 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
1760 LLVMValueRef ConstantIfTrue,
1761 LLVMValueRef ConstantIfFalse);
1762 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
1763 LLVMValueRef IndexConstant);
1764 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
1765 LLVMValueRef ElementValueConstant,
1766 LLVMValueRef IndexConstant);
1767 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
1768 LLVMValueRef VectorBConstant,
1769 LLVMValueRef MaskConstant);
1770 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
1772 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
1773 LLVMValueRef ElementValueConstant,
1774 unsigned *IdxList, unsigned NumIdx);
1775 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
1776 const char *AsmString, const char *Constraints,
1777 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
1778 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
1785 * @defgroup LLVMCCoreValueConstantGlobals Global Values
1787 * This group contains functions that operate on global values. Functions in
1788 * this group relate to functions in the llvm::GlobalValue class tree.
1790 * @see llvm::GlobalValue
1795 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
1796 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
1797 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
1798 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
1799 const char *LLVMGetSection(LLVMValueRef Global);
1800 void LLVMSetSection(LLVMValueRef Global, const char *Section);
1801 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
1802 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
1803 LLVMDLLStorageClass LLVMGetDLLStorageClass(LLVMValueRef Global);
1804 void LLVMSetDLLStorageClass(LLVMValueRef Global, LLVMDLLStorageClass Class);
1805 LLVMBool LLVMHasUnnamedAddr(LLVMValueRef Global);
1806 void LLVMSetUnnamedAddr(LLVMValueRef Global, LLVMBool HasUnnamedAddr);
1809 * @defgroup LLVMCCoreValueWithAlignment Values with alignment
1811 * Functions in this group only apply to values with alignment, i.e.
1812 * global variables, load and store instructions.
1816 * Obtain the preferred alignment of the value.
1817 * @see llvm::AllocaInst::getAlignment()
1818 * @see llvm::LoadInst::getAlignment()
1819 * @see llvm::StoreInst::getAlignment()
1820 * @see llvm::GlobalValue::getAlignment()
1822 unsigned LLVMGetAlignment(LLVMValueRef V);
1825 * Set the preferred alignment of the value.
1826 * @see llvm::AllocaInst::setAlignment()
1827 * @see llvm::LoadInst::setAlignment()
1828 * @see llvm::StoreInst::setAlignment()
1829 * @see llvm::GlobalValue::setAlignment()
1831 void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes);
1838 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables
1840 * This group contains functions that operate on global variable values.
1842 * @see llvm::GlobalVariable
1846 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
1847 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
1849 unsigned AddressSpace);
1850 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
1851 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
1852 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
1853 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
1854 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
1855 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
1856 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
1857 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
1858 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
1859 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
1860 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
1861 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
1862 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar);
1863 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode);
1864 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar);
1865 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit);
1872 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases
1874 * This group contains function that operate on global alias values.
1876 * @see llvm::GlobalAlias
1880 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
1888 * @defgroup LLVMCCoreValueFunction Function values
1890 * Functions in this group operate on LLVMValueRef instances that
1891 * correspond to llvm::Function instances.
1893 * @see llvm::Function
1899 * Remove a function from its containing module and deletes it.
1901 * @see llvm::Function::eraseFromParent()
1903 void LLVMDeleteFunction(LLVMValueRef Fn);
1906 * Obtain the personality function attached to the function.
1908 * @see llvm::Function::getPersonalityFn()
1910 LLVMValueRef LLVMGetPersonalityFn(LLVMValueRef Fn);
1913 * Set the personality function attached to the function.
1915 * @see llvm::Function::setPersonalityFn()
1917 void LLVMSetPersonalityFn(LLVMValueRef Fn, LLVMValueRef PersonalityFn);
1920 * Obtain the ID number from a function instance.
1922 * @see llvm::Function::getIntrinsicID()
1924 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
1927 * Obtain the calling function of a function.
1929 * The returned value corresponds to the LLVMCallConv enumeration.
1931 * @see llvm::Function::getCallingConv()
1933 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
1936 * Set the calling convention of a function.
1938 * @see llvm::Function::setCallingConv()
1940 * @param Fn Function to operate on
1941 * @param CC LLVMCallConv to set calling convention to
1943 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
1946 * Obtain the name of the garbage collector to use during code
1949 * @see llvm::Function::getGC()
1951 const char *LLVMGetGC(LLVMValueRef Fn);
1954 * Define the garbage collector to use during code generation.
1956 * @see llvm::Function::setGC()
1958 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
1961 * Add an attribute to a function.
1963 * @see llvm::Function::addAttribute()
1965 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1968 * Add a target-dependent attribute to a function
1969 * @see llvm::AttrBuilder::addAttribute()
1971 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A,
1975 * Obtain an attribute from a function.
1977 * @see llvm::Function::getAttributes()
1979 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
1982 * Remove an attribute from a function.
1984 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
1987 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters
1989 * Functions in this group relate to arguments/parameters on functions.
1991 * Functions in this group expect LLVMValueRef instances that correspond
1992 * to llvm::Function instances.
1998 * Obtain the number of parameters in a function.
2000 * @see llvm::Function::arg_size()
2002 unsigned LLVMCountParams(LLVMValueRef Fn);
2005 * Obtain the parameters in a function.
2007 * The takes a pointer to a pre-allocated array of LLVMValueRef that is
2008 * at least LLVMCountParams() long. This array will be filled with
2009 * LLVMValueRef instances which correspond to the parameters the
2010 * function receives. Each LLVMValueRef corresponds to a llvm::Argument
2013 * @see llvm::Function::arg_begin()
2015 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
2018 * Obtain the parameter at the specified index.
2020 * Parameters are indexed from 0.
2022 * @see llvm::Function::arg_begin()
2024 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
2027 * Obtain the function to which this argument belongs.
2029 * Unlike other functions in this group, this one takes an LLVMValueRef
2030 * that corresponds to a llvm::Attribute.
2032 * The returned LLVMValueRef is the llvm::Function to which this
2035 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
2038 * Obtain the first parameter to a function.
2040 * @see llvm::Function::arg_begin()
2042 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
2045 * Obtain the last parameter to a function.
2047 * @see llvm::Function::arg_end()
2049 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
2052 * Obtain the next parameter to a function.
2054 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is
2055 * actually a wrapped iterator) and obtains the next parameter from the
2056 * underlying iterator.
2058 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
2061 * Obtain the previous parameter to a function.
2063 * This is the opposite of LLVMGetNextParam().
2065 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
2068 * Add an attribute to a function argument.
2070 * @see llvm::Argument::addAttr()
2072 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
2075 * Remove an attribute from a function argument.
2077 * @see llvm::Argument::removeAttr()
2079 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
2082 * Get an attribute from a function argument.
2084 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
2087 * Set the alignment for a function parameter.
2089 * @see llvm::Argument::addAttr()
2090 * @see llvm::AttrBuilder::addAlignmentAttr()
2092 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
2111 * @defgroup LLVMCCoreValueMetadata Metadata
2117 * Obtain a MDString value from a context.
2119 * The returned instance corresponds to the llvm::MDString class.
2121 * The instance is specified by string data of a specified length. The
2122 * string content is copied, so the backing memory can be freed after
2123 * this function returns.
2125 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
2129 * Obtain a MDString value from the global context.
2131 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
2134 * Obtain a MDNode value from a context.
2136 * The returned value corresponds to the llvm::MDNode class.
2138 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
2142 * Obtain a MDNode value from the global context.
2144 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
2147 * Obtain the underlying string from a MDString value.
2149 * @param V Instance to obtain string from.
2150 * @param Len Memory address which will hold length of returned string.
2151 * @return String data in MDString.
2153 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
2156 * Obtain the number of operands from an MDNode value.
2158 * @param V MDNode to get number of operands from.
2159 * @return Number of operands of the MDNode.
2161 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V);
2164 * Obtain the given MDNode's operands.
2166 * The passed LLVMValueRef pointer should point to enough memory to hold all of
2167 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as
2168 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the
2169 * MDNode's operands.
2171 * @param V MDNode to get the operands from.
2172 * @param Dest Destination array for operands.
2174 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest);
2181 * @defgroup LLVMCCoreValueBasicBlock Basic Block
2183 * A basic block represents a single entry single exit section of code.
2184 * Basic blocks contain a list of instructions which form the body of
2187 * Basic blocks belong to functions. They have the type of label.
2189 * Basic blocks are themselves values. However, the C API models them as
2190 * LLVMBasicBlockRef.
2192 * @see llvm::BasicBlock
2198 * Convert a basic block instance to a value type.
2200 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
2203 * Determine whether an LLVMValueRef is itself a basic block.
2205 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
2208 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
2210 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
2213 * Obtain the function to which a basic block belongs.
2215 * @see llvm::BasicBlock::getParent()
2217 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
2220 * Obtain the terminator instruction for a basic block.
2222 * If the basic block does not have a terminator (it is not well-formed
2223 * if it doesn't), then NULL is returned.
2225 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst.
2227 * @see llvm::BasicBlock::getTerminator()
2229 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
2232 * Obtain the number of basic blocks in a function.
2234 * @param Fn Function value to operate on.
2236 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
2239 * Obtain all of the basic blocks in a function.
2241 * This operates on a function value. The BasicBlocks parameter is a
2242 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least
2243 * LLVMCountBasicBlocks() in length. This array is populated with
2244 * LLVMBasicBlockRef instances.
2246 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
2249 * Obtain the first basic block in a function.
2251 * The returned basic block can be used as an iterator. You will likely
2252 * eventually call into LLVMGetNextBasicBlock() with it.
2254 * @see llvm::Function::begin()
2256 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
2259 * Obtain the last basic block in a function.
2261 * @see llvm::Function::end()
2263 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
2266 * Advance a basic block iterator.
2268 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
2271 * Go backwards in a basic block iterator.
2273 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
2276 * Obtain the basic block that corresponds to the entry point of a
2279 * @see llvm::Function::getEntryBlock()
2281 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
2284 * Append a basic block to the end of a function.
2286 * @see llvm::BasicBlock::Create()
2288 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
2293 * Append a basic block to the end of a function using the global
2296 * @see llvm::BasicBlock::Create()
2298 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
2301 * Insert a basic block in a function before another basic block.
2303 * The function to add to is determined by the function of the
2304 * passed basic block.
2306 * @see llvm::BasicBlock::Create()
2308 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
2309 LLVMBasicBlockRef BB,
2313 * Insert a basic block in a function using the global context.
2315 * @see llvm::BasicBlock::Create()
2317 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
2321 * Remove a basic block from a function and delete it.
2323 * This deletes the basic block from its containing function and deletes
2324 * the basic block itself.
2326 * @see llvm::BasicBlock::eraseFromParent()
2328 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
2331 * Remove a basic block from a function.
2333 * This deletes the basic block from its containing function but keep
2334 * the basic block alive.
2336 * @see llvm::BasicBlock::removeFromParent()
2338 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
2341 * Move a basic block to before another one.
2343 * @see llvm::BasicBlock::moveBefore()
2345 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2348 * Move a basic block to after another one.
2350 * @see llvm::BasicBlock::moveAfter()
2352 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
2355 * Obtain the first instruction in a basic block.
2357 * The returned LLVMValueRef corresponds to a llvm::Instruction
2360 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
2363 * Obtain the last instruction in a basic block.
2365 * The returned LLVMValueRef corresponds to an LLVM:Instruction.
2367 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
2374 * @defgroup LLVMCCoreValueInstruction Instructions
2376 * Functions in this group relate to the inspection and manipulation of
2377 * individual instructions.
2379 * In the C++ API, an instruction is modeled by llvm::Instruction. This
2380 * class has a large number of descendents. llvm::Instruction is a
2381 * llvm::Value and in the C API, instructions are modeled by
2384 * This group also contains sub-groups which operate on specific
2385 * llvm::Instruction types, e.g. llvm::CallInst.
2391 * Determine whether an instruction has any metadata attached.
2393 int LLVMHasMetadata(LLVMValueRef Val);
2396 * Return metadata associated with an instruction value.
2398 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
2401 * Set metadata associated with an instruction value.
2403 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
2406 * Obtain the basic block to which an instruction belongs.
2408 * @see llvm::Instruction::getParent()
2410 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
2413 * Obtain the instruction that occurs after the one specified.
2415 * The next instruction will be from the same basic block.
2417 * If this is the last instruction in a basic block, NULL will be
2420 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
2423 * Obtain the instruction that occurred before this one.
2425 * If the instruction is the first instruction in a basic block, NULL
2428 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
2431 * Remove and delete an instruction.
2433 * The instruction specified is removed from its containing building
2434 * block and then deleted.
2436 * @see llvm::Instruction::eraseFromParent()
2438 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
2441 * Obtain the code opcode for an individual instruction.
2443 * @see llvm::Instruction::getOpCode()
2445 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst);
2448 * Obtain the predicate of an instruction.
2450 * This is only valid for instructions that correspond to llvm::ICmpInst
2451 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp.
2453 * @see llvm::ICmpInst::getPredicate()
2455 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
2458 * Obtain the float predicate of an instruction.
2460 * This is only valid for instructions that correspond to llvm::FCmpInst
2461 * or llvm::ConstantExpr whose opcode is llvm::Instruction::FCmp.
2463 * @see llvm::FCmpInst::getPredicate()
2465 LLVMRealPredicate LLVMGetFCmpPredicate(LLVMValueRef Inst);
2468 * Create a copy of 'this' instruction that is identical in all ways
2469 * except the following:
2470 * * The instruction has no parent
2471 * * The instruction has no name
2473 * @see llvm::Instruction::clone()
2475 LLVMValueRef LLVMInstructionClone(LLVMValueRef Inst);
2478 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations
2480 * Functions in this group apply to instructions that refer to call
2481 * sites and invocations. These correspond to C++ types in the
2482 * llvm::CallInst class tree.
2488 * Set the calling convention for a call instruction.
2490 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or
2493 * @see llvm::CallInst::setCallingConv()
2494 * @see llvm::InvokeInst::setCallingConv()
2496 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
2499 * Obtain the calling convention for a call instruction.
2501 * This is the opposite of LLVMSetInstructionCallConv(). Reads its
2504 * @see LLVMSetInstructionCallConv()
2506 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
2509 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
2510 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
2512 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
2516 * Obtain whether a call instruction is a tail call.
2518 * This only works on llvm::CallInst instructions.
2520 * @see llvm::CallInst::isTailCall()
2522 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
2525 * Set whether a call instruction is a tail call.
2527 * This only works on llvm::CallInst instructions.
2529 * @see llvm::CallInst::setTailCall()
2531 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
2538 * @defgroup LLVMCCoreValueInstructionTerminator Terminators
2540 * Functions in this group only apply to instructions that map to
2541 * llvm::TerminatorInst instances.
2547 * Return the number of successors that this terminator has.
2549 * @see llvm::TerminatorInst::getNumSuccessors
2551 unsigned LLVMGetNumSuccessors(LLVMValueRef Term);
2554 * Return the specified successor.
2556 * @see llvm::TerminatorInst::getSuccessor
2558 LLVMBasicBlockRef LLVMGetSuccessor(LLVMValueRef Term, unsigned i);
2561 * Update the specified successor to point at the provided block.
2563 * @see llvm::TerminatorInst::setSuccessor
2565 void LLVMSetSuccessor(LLVMValueRef Term, unsigned i, LLVMBasicBlockRef block);
2568 * Return if a branch is conditional.
2570 * This only works on llvm::BranchInst instructions.
2572 * @see llvm::BranchInst::isConditional
2574 LLVMBool LLVMIsConditional(LLVMValueRef Branch);
2577 * Return the condition of a branch instruction.
2579 * This only works on llvm::BranchInst instructions.
2581 * @see llvm::BranchInst::getCondition
2583 LLVMValueRef LLVMGetCondition(LLVMValueRef Branch);
2586 * Set the condition of a branch instruction.
2588 * This only works on llvm::BranchInst instructions.
2590 * @see llvm::BranchInst::setCondition
2592 void LLVMSetCondition(LLVMValueRef Branch, LLVMValueRef Cond);
2595 * Obtain the default destination basic block of a switch instruction.
2597 * This only works on llvm::SwitchInst instructions.
2599 * @see llvm::SwitchInst::getDefaultDest()
2601 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
2608 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes
2610 * Functions in this group only apply to instructions that map to
2611 * llvm::PHINode instances.
2617 * Add an incoming value to the end of a PHI list.
2619 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
2620 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
2623 * Obtain the number of incoming basic blocks to a PHI node.
2625 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
2628 * Obtain an incoming value to a PHI node as an LLVMValueRef.
2630 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
2633 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef.
2635 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
2650 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders
2652 * An instruction builder represents a point within a basic block and is
2653 * the exclusive means of building instructions using the C interface.
2658 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
2659 LLVMBuilderRef LLVMCreateBuilder(void);
2660 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
2661 LLVMValueRef Instr);
2662 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
2663 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
2664 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
2665 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
2666 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
2667 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
2669 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
2672 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
2673 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
2674 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
2677 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
2678 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
2679 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
2681 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
2682 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
2683 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
2684 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
2685 LLVMBasicBlockRef Else, unsigned NumCases);
2686 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
2688 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
2689 LLVMValueRef *Args, unsigned NumArgs,
2690 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
2692 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
2693 LLVMValueRef PersFn, unsigned NumClauses,
2695 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
2696 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
2698 /* Add a case to the switch instruction */
2699 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
2700 LLVMBasicBlockRef Dest);
2702 /* Add a destination to the indirectbr instruction */
2703 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
2705 /* Add a catch or filter clause to the landingpad instruction */
2706 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
2708 /* Set the 'cleanup' flag in the landingpad instruction */
2709 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
2712 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2714 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2716 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2718 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2720 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2722 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2724 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2726 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2728 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2730 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2732 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2734 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2736 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2738 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2740 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2742 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2744 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2746 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2748 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2750 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2752 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2754 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2756 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2758 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2760 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
2762 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
2763 LLVMValueRef LHS, LLVMValueRef RHS,
2765 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2766 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
2768 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
2770 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2771 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
2774 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2775 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
2776 LLVMValueRef Val, const char *Name);
2777 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2778 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
2779 LLVMValueRef Val, const char *Name);
2780 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
2781 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
2783 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
2784 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2785 LLVMValueRef *Indices, unsigned NumIndices,
2787 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2788 LLVMValueRef *Indices, unsigned NumIndices,
2790 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
2791 unsigned Idx, const char *Name);
2792 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
2794 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
2796 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst);
2797 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile);
2798 LLVMAtomicOrdering LLVMGetOrdering(LLVMValueRef MemoryAccessInst);
2799 void LLVMSetOrdering(LLVMValueRef MemoryAccessInst, LLVMAtomicOrdering Ordering);
2802 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
2803 LLVMTypeRef DestTy, const char *Name);
2804 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
2805 LLVMTypeRef DestTy, const char *Name);
2806 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
2807 LLVMTypeRef DestTy, const char *Name);
2808 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
2809 LLVMTypeRef DestTy, const char *Name);
2810 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
2811 LLVMTypeRef DestTy, const char *Name);
2812 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
2813 LLVMTypeRef DestTy, const char *Name);
2814 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
2815 LLVMTypeRef DestTy, const char *Name);
2816 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
2817 LLVMTypeRef DestTy, const char *Name);
2818 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
2819 LLVMTypeRef DestTy, const char *Name);
2820 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
2821 LLVMTypeRef DestTy, const char *Name);
2822 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
2823 LLVMTypeRef DestTy, const char *Name);
2824 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
2825 LLVMTypeRef DestTy, const char *Name);
2826 LLVMValueRef LLVMBuildAddrSpaceCast(LLVMBuilderRef, LLVMValueRef Val,
2827 LLVMTypeRef DestTy, const char *Name);
2828 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2829 LLVMTypeRef DestTy, const char *Name);
2830 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2831 LLVMTypeRef DestTy, const char *Name);
2832 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
2833 LLVMTypeRef DestTy, const char *Name);
2834 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
2835 LLVMTypeRef DestTy, const char *Name);
2836 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
2837 LLVMTypeRef DestTy, const char *Name);
2838 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
2839 LLVMTypeRef DestTy, const char *Name);
2840 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
2841 LLVMTypeRef DestTy, const char *Name);
2844 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
2845 LLVMValueRef LHS, LLVMValueRef RHS,
2847 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
2848 LLVMValueRef LHS, LLVMValueRef RHS,
2851 /* Miscellaneous instructions */
2852 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
2853 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
2854 LLVMValueRef *Args, unsigned NumArgs,
2856 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
2857 LLVMValueRef Then, LLVMValueRef Else,
2859 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
2861 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
2862 LLVMValueRef Index, const char *Name);
2863 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
2864 LLVMValueRef EltVal, LLVMValueRef Index,
2866 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
2867 LLVMValueRef V2, LLVMValueRef Mask,
2869 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
2870 unsigned Index, const char *Name);
2871 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
2872 LLVMValueRef EltVal, unsigned Index,
2875 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
2877 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
2879 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
2880 LLVMValueRef RHS, const char *Name);
2881 LLVMValueRef LLVMBuildFence(LLVMBuilderRef B, LLVMAtomicOrdering ordering,
2882 LLVMBool singleThread, const char *Name);
2883 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B, LLVMAtomicRMWBinOp op,
2884 LLVMValueRef PTR, LLVMValueRef Val,
2885 LLVMAtomicOrdering ordering,
2886 LLVMBool singleThread);
2893 * @defgroup LLVMCCoreModuleProvider Module Providers
2899 * Changes the type of M so it can be passed to FunctionPassManagers and the
2900 * JIT. They take ModuleProviders for historical reasons.
2902 LLVMModuleProviderRef
2903 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
2906 * Destroys the module M.
2908 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
2915 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers
2920 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
2921 LLVMMemoryBufferRef *OutMemBuf,
2923 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
2925 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData,
2926 size_t InputDataLength,
2927 const char *BufferName,
2928 LLVMBool RequiresNullTerminator);
2929 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData,
2930 size_t InputDataLength,
2931 const char *BufferName);
2932 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf);
2933 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf);
2934 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
2941 * @defgroup LLVMCCorePassRegistry Pass Registry
2946 /** Return the global pass registry, for use with initialization functions.
2947 @see llvm::PassRegistry::getPassRegistry */
2948 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
2955 * @defgroup LLVMCCorePassManagers Pass Managers
2960 /** Constructs a new whole-module pass pipeline. This type of pipeline is
2961 suitable for link-time optimization and whole-module transformations.
2962 @see llvm::PassManager::PassManager */
2963 LLVMPassManagerRef LLVMCreatePassManager(void);
2965 /** Constructs a new function-by-function pass pipeline over the module
2966 provider. It does not take ownership of the module provider. This type of
2967 pipeline is suitable for code generation and JIT compilation tasks.
2968 @see llvm::FunctionPassManager::FunctionPassManager */
2969 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
2971 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
2972 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
2974 /** Initializes, executes on the provided module, and finalizes all of the
2975 passes scheduled in the pass manager. Returns 1 if any of the passes
2976 modified the module, 0 otherwise.
2977 @see llvm::PassManager::run(Module&) */
2978 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
2980 /** Initializes all of the function passes scheduled in the function pass
2981 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2982 @see llvm::FunctionPassManager::doInitialization */
2983 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
2985 /** Executes all of the function passes scheduled in the function pass manager
2986 on the provided function. Returns 1 if any of the passes modified the
2987 function, false otherwise.
2988 @see llvm::FunctionPassManager::run(Function&) */
2989 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
2991 /** Finalizes all of the function passes scheduled in in the function pass
2992 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
2993 @see llvm::FunctionPassManager::doFinalization */
2994 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
2996 /** Frees the memory of a pass pipeline. For function pipelines, does not free
2997 the module provider.
2998 @see llvm::PassManagerBase::~PassManagerBase. */
2999 void LLVMDisposePassManager(LLVMPassManagerRef PM);
3006 * @defgroup LLVMCCoreThreading Threading
3008 * Handle the structures needed to make LLVM safe for multithreading.
3013 /** Deprecated: Multi-threading can only be enabled/disabled with the compile
3014 time define LLVM_ENABLE_THREADS. This function always returns
3015 LLVMIsMultithreaded(). */
3016 LLVMBool LLVMStartMultithreaded(void);
3018 /** Deprecated: Multi-threading can only be enabled/disabled with the compile
3019 time define LLVM_ENABLE_THREADS. */
3020 void LLVMStopMultithreaded(void);
3022 /** Check whether LLVM is executing in thread-safe mode or not.
3023 @see llvm::llvm_is_multithreaded */
3024 LLVMBool LLVMIsMultithreaded(void);
3040 #endif /* !defined(__cplusplus) */
3042 #endif /* !defined(LLVM_C_CORE_H) */