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 |* LLVM uses a polymorphic type hierarchy which C cannot represent, therefore *|
14 |* parameters must be passed as base types. Despite the declared types, most *|
15 |* of the functions provided operate only on branches of the type hierarchy. *|
16 |* The declared parameter names are descriptive and specify which type is *|
17 |* required. Additionally, each type hierarchy is documented along with the *|
18 |* functions that operate upon it. For more detail, refer to LLVM's C++ code. *|
19 |* If in doubt, refer to Core.cpp, which performs paramter downcasts in the *|
20 |* form unwrap<RequiredType>(Param). *|
22 |* Many exotic languages can interoperate with C code but have a harder time *|
23 |* with C++ due to name mangling. So in addition to C, this interface enables *|
24 |* tools written in such languages. *|
26 |* When included into a C++ source file, also declares 'wrap' and 'unwrap' *|
27 |* helpers to perform opaque reference<-->pointer conversions. These helpers *|
28 |* are shorter and more tightly typed than writing the casts by hand when *|
29 |* authoring bindings. In assert builds, they will do runtime type checking. *|
31 \*===----------------------------------------------------------------------===*/
36 #include "llvm/Support/DataTypes.h"
40 /* Need these includes to support the LLVM 'cast' template for the C++ 'wrap'
41 and 'unwrap' conversion functions. */
42 #include "llvm/Module.h"
43 #include "llvm/PassRegistry.h"
44 #include "llvm/Support/IRBuilder.h"
55 * The top-level container for all LLVM global data. See the LLVMContext class.
57 typedef struct LLVMOpaqueContext *LLVMContextRef;
60 * The top-level container for all other LLVM Intermediate Representation (IR)
61 * objects. See the llvm::Module class.
63 typedef struct LLVMOpaqueModule *LLVMModuleRef;
66 * Each value in the LLVM IR has a type, an LLVMTypeRef. See the llvm::Type
69 typedef struct LLVMOpaqueType *LLVMTypeRef;
71 typedef struct LLVMOpaqueValue *LLVMValueRef;
72 typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
73 typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
75 /* Interface used to provide a module to JIT or interpreter. This is now just a
76 * synonym for llvm::Module, but we have to keep using the different type to
77 * keep binary compatibility.
79 typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
81 /* Used to provide a module to JIT or interpreter.
82 * See the llvm::MemoryBuffer class.
84 typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
86 /** See the llvm::PassManagerBase class. */
87 typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
89 /** See the llvm::PassRegistry class. */
90 typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef;
92 /** Used to get the users and usees of a Value. See the llvm::Use class. */
93 typedef struct LLVMOpaqueUse *LLVMUseRef;
96 LLVMZExtAttribute = 1<<0,
97 LLVMSExtAttribute = 1<<1,
98 LLVMNoReturnAttribute = 1<<2,
99 LLVMInRegAttribute = 1<<3,
100 LLVMStructRetAttribute = 1<<4,
101 LLVMNoUnwindAttribute = 1<<5,
102 LLVMNoAliasAttribute = 1<<6,
103 LLVMByValAttribute = 1<<7,
104 LLVMNestAttribute = 1<<8,
105 LLVMReadNoneAttribute = 1<<9,
106 LLVMReadOnlyAttribute = 1<<10,
107 LLVMNoInlineAttribute = 1<<11,
108 LLVMAlwaysInlineAttribute = 1<<12,
109 LLVMOptimizeForSizeAttribute = 1<<13,
110 LLVMStackProtectAttribute = 1<<14,
111 LLVMStackProtectReqAttribute = 1<<15,
112 LLVMAlignment = 31<<16,
113 LLVMNoCaptureAttribute = 1<<21,
114 LLVMNoRedZoneAttribute = 1<<22,
115 LLVMNoImplicitFloatAttribute = 1<<23,
116 LLVMNakedAttribute = 1<<24,
117 LLVMInlineHintAttribute = 1<<25,
118 LLVMStackAlignment = 7<<26
122 /* Terminator Instructions */
128 /* removed 6 due to API changes */
131 /* Standard Binary Operators */
145 /* Logical Operators */
153 /* Memory Operators */
157 LLVMGetElementPtr = 29,
173 /* Other Operators */
182 LLVMExtractElement = 50,
183 LLVMInsertElement = 51,
184 LLVMShuffleVector = 52,
185 LLVMExtractValue = 53,
186 LLVMInsertValue = 54,
188 /* Atomic operators */
190 LLVMAtomicCmpXchg = 56,
193 /* Exception Handling Operators */
200 LLVMVoidTypeKind, /**< type with no size */
201 LLVMFloatTypeKind, /**< 32 bit floating point type */
202 LLVMDoubleTypeKind, /**< 64 bit floating point type */
203 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
204 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
205 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
206 LLVMLabelTypeKind, /**< Labels */
207 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
208 LLVMFunctionTypeKind, /**< Functions */
209 LLVMStructTypeKind, /**< Structures */
210 LLVMArrayTypeKind, /**< Arrays */
211 LLVMPointerTypeKind, /**< Pointers */
212 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
213 LLVMMetadataTypeKind, /**< Metadata */
214 LLVMX86_MMXTypeKind /**< X86 MMX */
218 LLVMExternalLinkage, /**< Externally visible function */
219 LLVMAvailableExternallyLinkage,
220 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
221 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
223 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
224 LLVMWeakODRLinkage, /**< Same, but only replaced by something
226 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
227 LLVMInternalLinkage, /**< Rename collisions when linking (static
229 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
230 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
231 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
232 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
233 LLVMGhostLinkage, /**< Obsolete */
234 LLVMCommonLinkage, /**< Tentative definitions */
235 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
236 LLVMLinkerPrivateWeakLinkage, /**< Like LinkerPrivate, but is weak. */
237 LLVMLinkerPrivateWeakDefAutoLinkage /**< Like LinkerPrivateWeak, but possibly
242 LLVMDefaultVisibility, /**< The GV is visible */
243 LLVMHiddenVisibility, /**< The GV is hidden */
244 LLVMProtectedVisibility /**< The GV is protected */
249 LLVMFastCallConv = 8,
250 LLVMColdCallConv = 9,
251 LLVMX86StdcallCallConv = 64,
252 LLVMX86FastcallCallConv = 65
256 LLVMIntEQ = 32, /**< equal */
257 LLVMIntNE, /**< not equal */
258 LLVMIntUGT, /**< unsigned greater than */
259 LLVMIntUGE, /**< unsigned greater or equal */
260 LLVMIntULT, /**< unsigned less than */
261 LLVMIntULE, /**< unsigned less or equal */
262 LLVMIntSGT, /**< signed greater than */
263 LLVMIntSGE, /**< signed greater or equal */
264 LLVMIntSLT, /**< signed less than */
265 LLVMIntSLE /**< signed less or equal */
269 LLVMRealPredicateFalse, /**< Always false (always folded) */
270 LLVMRealOEQ, /**< True if ordered and equal */
271 LLVMRealOGT, /**< True if ordered and greater than */
272 LLVMRealOGE, /**< True if ordered and greater than or equal */
273 LLVMRealOLT, /**< True if ordered and less than */
274 LLVMRealOLE, /**< True if ordered and less than or equal */
275 LLVMRealONE, /**< True if ordered and operands are unequal */
276 LLVMRealORD, /**< True if ordered (no nans) */
277 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
278 LLVMRealUEQ, /**< True if unordered or equal */
279 LLVMRealUGT, /**< True if unordered or greater than */
280 LLVMRealUGE, /**< True if unordered, greater than, or equal */
281 LLVMRealULT, /**< True if unordered or less than */
282 LLVMRealULE, /**< True if unordered, less than, or equal */
283 LLVMRealUNE, /**< True if unordered or not equal */
284 LLVMRealPredicateTrue /**< Always true (always folded) */
288 LLVMLandingPadCatch, /**< A catch clause */
289 LLVMLandingPadFilter /**< A filter clause */
290 } LLVMLandingPadClauseTy;
292 void LLVMInitializeCore(LLVMPassRegistryRef R);
295 /*===-- Error handling ----------------------------------------------------===*/
297 void LLVMDisposeMessage(char *Message);
300 /*===-- Contexts ----------------------------------------------------------===*/
302 /* Create and destroy contexts. */
303 LLVMContextRef LLVMContextCreate(void);
304 LLVMContextRef LLVMGetGlobalContext(void);
305 void LLVMContextDispose(LLVMContextRef C);
307 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
309 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
311 /*===-- Modules -----------------------------------------------------------===*/
313 /* Create and destroy modules. */
314 /** See llvm::Module::Module. */
315 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
316 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
319 /** See llvm::Module::~Module. */
320 void LLVMDisposeModule(LLVMModuleRef M);
322 /** Data layout. See Module::getDataLayout. */
323 const char *LLVMGetDataLayout(LLVMModuleRef M);
324 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
326 /** Target triple. See Module::getTargetTriple. */
327 const char *LLVMGetTarget(LLVMModuleRef M);
328 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
330 /** See Module::dump. */
331 void LLVMDumpModule(LLVMModuleRef M);
333 /** See Module::setModuleInlineAsm. */
334 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
336 /** See Module::getContext. */
337 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
339 /*===-- Types -------------------------------------------------------------===*/
341 /* LLVM types conform to the following hierarchy:
356 /** See llvm::LLVMTypeKind::getTypeID. */
357 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
359 /** See llvm::LLVMType::getContext. */
360 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
362 /* Operations on integer types */
363 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
364 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
365 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
366 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
367 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
368 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
370 LLVMTypeRef LLVMInt1Type(void);
371 LLVMTypeRef LLVMInt8Type(void);
372 LLVMTypeRef LLVMInt16Type(void);
373 LLVMTypeRef LLVMInt32Type(void);
374 LLVMTypeRef LLVMInt64Type(void);
375 LLVMTypeRef LLVMIntType(unsigned NumBits);
376 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
378 /* Operations on real types */
379 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
380 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
381 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
382 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
383 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
385 LLVMTypeRef LLVMFloatType(void);
386 LLVMTypeRef LLVMDoubleType(void);
387 LLVMTypeRef LLVMX86FP80Type(void);
388 LLVMTypeRef LLVMFP128Type(void);
389 LLVMTypeRef LLVMPPCFP128Type(void);
391 /* Operations on function types */
392 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
393 LLVMTypeRef *ParamTypes, unsigned ParamCount,
395 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
396 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
397 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
398 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
400 /* Operations on struct types */
401 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
402 unsigned ElementCount, LLVMBool Packed);
403 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
405 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
406 const char *LLVMGetStructName(LLVMTypeRef Ty);
407 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
408 unsigned ElementCount, LLVMBool Packed);
410 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
411 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
412 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
413 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
415 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
417 /* Operations on array, pointer, and vector types (sequence types) */
418 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
419 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
420 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
422 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
423 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
424 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
425 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
427 /* Operations on other types */
428 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
429 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
430 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
432 LLVMTypeRef LLVMVoidType(void);
433 LLVMTypeRef LLVMLabelType(void);
434 LLVMTypeRef LLVMX86MMXType(void);
436 /*===-- Values ------------------------------------------------------------===*/
438 /* The bulk of LLVM's object model consists of values, which comprise a very
439 * rich type hierarchy.
442 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
448 macro(ConstantAggregateZero) \
449 macro(ConstantArray) \
450 macro(ConstantExpr) \
453 macro(ConstantPointerNull) \
454 macro(ConstantStruct) \
455 macro(ConstantVector) \
459 macro(GlobalVariable) \
462 macro(BinaryOperator) \
464 macro(IntrinsicInst) \
465 macro(DbgInfoIntrinsic) \
466 macro(DbgDeclareInst) \
467 macro(EHSelectorInst) \
468 macro(MemIntrinsic) \
475 macro(ExtractElementInst) \
476 macro(GetElementPtrInst) \
477 macro(InsertElementInst) \
478 macro(InsertValueInst) \
479 macro(LandingPadInst) \
482 macro(ShuffleVectorInst) \
484 macro(TerminatorInst) \
489 macro(UnreachableInst) \
491 macro(UnaryInstruction) \
499 macro(IntToPtrInst) \
500 macro(PtrToIntInst) \
506 macro(ExtractValueInst) \
510 /* Operations on all values */
511 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
512 const char *LLVMGetValueName(LLVMValueRef Val);
513 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
514 void LLVMDumpValue(LLVMValueRef Val);
515 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
516 int LLVMHasMetadata(LLVMValueRef Val);
517 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
518 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
520 /* Conversion functions. Return the input value if it is an instance of the
521 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
522 #define LLVM_DECLARE_VALUE_CAST(name) \
523 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
524 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
526 /* Operations on Uses */
527 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
528 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
529 LLVMValueRef LLVMGetUser(LLVMUseRef U);
530 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
532 /* Operations on Users */
533 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
534 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
535 int LLVMGetNumOperands(LLVMValueRef Val);
537 /* Operations on constants of any type */
538 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
539 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
540 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
541 LLVMBool LLVMIsConstant(LLVMValueRef Val);
542 LLVMBool LLVMIsNull(LLVMValueRef Val);
543 LLVMBool LLVMIsUndef(LLVMValueRef Val);
544 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
546 /* Operations on metadata */
547 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
549 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
550 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
552 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
553 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
554 int LLVMGetMDNodeNumOperands(LLVMValueRef V);
555 LLVMValueRef *LLVMGetMDNodeOperand(LLVMValueRef V, unsigned i);
556 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
557 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
559 /* Operations on scalar constants */
560 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
561 LLVMBool SignExtend);
562 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
564 const uint64_t Words[]);
565 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
567 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
568 unsigned SLen, uint8_t Radix);
569 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
570 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
571 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
573 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
574 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
577 /* Operations on composite constants */
578 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
579 unsigned Length, LLVMBool DontNullTerminate);
580 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
581 LLVMValueRef *ConstantVals,
582 unsigned Count, LLVMBool Packed);
584 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
585 LLVMBool DontNullTerminate);
586 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
587 LLVMValueRef *ConstantVals, unsigned Length);
588 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
590 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
591 LLVMValueRef *ConstantVals,
593 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
595 /* Constant expressions */
596 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
597 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
598 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
599 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
600 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
601 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
602 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
603 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
604 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
605 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
606 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
607 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
609 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
611 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
612 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
613 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
614 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
615 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
616 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
617 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
618 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
619 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
620 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
621 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
622 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
623 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
624 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
625 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
626 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
627 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
628 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
629 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
630 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
631 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
632 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
633 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
634 LLVMValueRef *ConstantIndices, unsigned NumIndices);
635 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
636 LLVMValueRef *ConstantIndices,
637 unsigned NumIndices);
638 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
639 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
640 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
641 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
642 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
643 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
644 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
645 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
646 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
647 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
648 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
649 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
650 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
652 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
654 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
656 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
658 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
660 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
661 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
662 LLVMValueRef ConstantIfTrue,
663 LLVMValueRef ConstantIfFalse);
664 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
665 LLVMValueRef IndexConstant);
666 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
667 LLVMValueRef ElementValueConstant,
668 LLVMValueRef IndexConstant);
669 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
670 LLVMValueRef VectorBConstant,
671 LLVMValueRef MaskConstant);
672 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
674 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
675 LLVMValueRef ElementValueConstant,
676 unsigned *IdxList, unsigned NumIdx);
677 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
678 const char *AsmString, const char *Constraints,
679 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
680 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
682 /* Operations on global variables, functions, and aliases (globals) */
683 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
684 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
685 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
686 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
687 const char *LLVMGetSection(LLVMValueRef Global);
688 void LLVMSetSection(LLVMValueRef Global, const char *Section);
689 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
690 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
691 unsigned LLVMGetAlignment(LLVMValueRef Global);
692 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
694 /* Operations on global variables */
695 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
696 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
698 unsigned AddressSpace);
699 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
700 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
701 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
702 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
703 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
704 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
705 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
706 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
707 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
708 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
709 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
710 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
712 /* Operations on aliases */
713 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
716 /* Operations on functions */
717 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
718 LLVMTypeRef FunctionTy);
719 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
720 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
721 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
722 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
723 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
724 void LLVMDeleteFunction(LLVMValueRef Fn);
725 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
726 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
727 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
728 const char *LLVMGetGC(LLVMValueRef Fn);
729 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
730 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
731 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
732 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
734 /* Operations on parameters */
735 unsigned LLVMCountParams(LLVMValueRef Fn);
736 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
737 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
738 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
739 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
740 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
741 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
742 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
743 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
744 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
745 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
746 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
748 /* Operations on basic blocks */
749 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
750 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
751 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
752 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
753 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
754 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
755 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
756 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
757 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
758 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
759 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
760 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
762 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
765 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
766 LLVMBasicBlockRef BB,
769 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
770 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
772 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
773 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
775 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
776 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
778 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
779 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
781 /* Operations on instructions */
782 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
783 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
784 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
785 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
786 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
788 /* Operations on call sites */
789 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
790 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
791 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
792 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
794 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
797 /* Operations on call instructions (only) */
798 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
799 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
801 /* Operations on switch instructions (only) */
802 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
804 /* Operations on phi nodes */
805 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
806 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
807 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
808 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
809 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
811 /*===-- Instruction builders ----------------------------------------------===*/
813 /* An instruction builder represents a point within a basic block, and is the
814 * exclusive means of building instructions using the C interface.
817 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
818 LLVMBuilderRef LLVMCreateBuilder(void);
819 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
821 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
822 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
823 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
824 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
825 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
826 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
828 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
831 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
832 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
833 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
836 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
837 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
838 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
840 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
841 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
842 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
843 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
844 LLVMBasicBlockRef Else, unsigned NumCases);
845 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
847 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
848 LLVMValueRef *Args, unsigned NumArgs,
849 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
851 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
852 LLVMValueRef PersFn, unsigned NumClauses,
854 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
855 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
857 /* Add a case to the switch instruction */
858 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
859 LLVMBasicBlockRef Dest);
861 /* Add a destination to the indirectbr instruction */
862 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
864 /* Add a catch or filter clause to the landingpad instruction */
865 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
867 /* Set the 'cleanup' flag in the landingpad instruction */
868 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
871 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
873 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
875 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
877 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
879 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
881 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
883 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
885 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
887 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
889 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
891 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
893 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
895 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
897 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
899 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
901 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
903 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
905 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
907 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
909 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
911 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
913 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
915 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
917 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
919 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
921 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
922 LLVMValueRef LHS, LLVMValueRef RHS,
924 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
925 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
927 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
929 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
930 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
933 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
934 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
935 LLVMValueRef Val, const char *Name);
936 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
937 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
938 LLVMValueRef Val, const char *Name);
939 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
940 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
942 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
943 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
944 LLVMValueRef *Indices, unsigned NumIndices,
946 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
947 LLVMValueRef *Indices, unsigned NumIndices,
949 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
950 unsigned Idx, const char *Name);
951 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
953 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
957 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
958 LLVMTypeRef DestTy, const char *Name);
959 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
960 LLVMTypeRef DestTy, const char *Name);
961 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
962 LLVMTypeRef DestTy, const char *Name);
963 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
964 LLVMTypeRef DestTy, const char *Name);
965 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
966 LLVMTypeRef DestTy, const char *Name);
967 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
968 LLVMTypeRef DestTy, const char *Name);
969 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
970 LLVMTypeRef DestTy, const char *Name);
971 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
972 LLVMTypeRef DestTy, const char *Name);
973 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
974 LLVMTypeRef DestTy, const char *Name);
975 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
976 LLVMTypeRef DestTy, const char *Name);
977 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
978 LLVMTypeRef DestTy, const char *Name);
979 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
980 LLVMTypeRef DestTy, const char *Name);
981 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
982 LLVMTypeRef DestTy, const char *Name);
983 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
984 LLVMTypeRef DestTy, const char *Name);
985 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
986 LLVMTypeRef DestTy, const char *Name);
987 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
988 LLVMTypeRef DestTy, const char *Name);
989 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
990 LLVMTypeRef DestTy, const char *Name);
991 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
992 LLVMTypeRef DestTy, const char *Name);
993 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
994 LLVMTypeRef DestTy, const char *Name);
997 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
998 LLVMValueRef LHS, LLVMValueRef RHS,
1000 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
1001 LLVMValueRef LHS, LLVMValueRef RHS,
1004 /* Miscellaneous instructions */
1005 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
1006 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
1007 LLVMValueRef *Args, unsigned NumArgs,
1009 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
1010 LLVMValueRef Then, LLVMValueRef Else,
1012 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
1014 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
1015 LLVMValueRef Index, const char *Name);
1016 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
1017 LLVMValueRef EltVal, LLVMValueRef Index,
1019 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
1020 LLVMValueRef V2, LLVMValueRef Mask,
1022 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
1023 unsigned Index, const char *Name);
1024 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
1025 LLVMValueRef EltVal, unsigned Index,
1028 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
1030 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
1032 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
1033 LLVMValueRef RHS, const char *Name);
1036 /*===-- Module providers --------------------------------------------------===*/
1038 /* Changes the type of M so it can be passed to FunctionPassManagers and the
1039 * JIT. They take ModuleProviders for historical reasons.
1041 LLVMModuleProviderRef
1042 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1044 /* Destroys the module M.
1046 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
1049 /*===-- Memory buffers ----------------------------------------------------===*/
1051 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1052 LLVMMemoryBufferRef *OutMemBuf,
1054 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1056 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1058 /*===-- Pass Registry -----------------------------------------------------===*/
1060 /** Return the global pass registry, for use with initialization functions.
1061 See llvm::PassRegistry::getPassRegistry. */
1062 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
1064 /*===-- Pass Managers -----------------------------------------------------===*/
1066 /** Constructs a new whole-module pass pipeline. This type of pipeline is
1067 suitable for link-time optimization and whole-module transformations.
1068 See llvm::PassManager::PassManager. */
1069 LLVMPassManagerRef LLVMCreatePassManager(void);
1071 /** Constructs a new function-by-function pass pipeline over the module
1072 provider. It does not take ownership of the module provider. This type of
1073 pipeline is suitable for code generation and JIT compilation tasks.
1074 See llvm::FunctionPassManager::FunctionPassManager. */
1075 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1077 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
1078 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1080 /** Initializes, executes on the provided module, and finalizes all of the
1081 passes scheduled in the pass manager. Returns 1 if any of the passes
1082 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
1083 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
1085 /** Initializes all of the function passes scheduled in the function pass
1086 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1087 See llvm::FunctionPassManager::doInitialization. */
1088 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
1090 /** Executes all of the function passes scheduled in the function pass manager
1091 on the provided function. Returns 1 if any of the passes modified the
1092 function, false otherwise.
1093 See llvm::FunctionPassManager::run(Function&). */
1094 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
1096 /** Finalizes all of the function passes scheduled in in the function pass
1097 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1098 See llvm::FunctionPassManager::doFinalization. */
1099 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
1101 /** Frees the memory of a pass pipeline. For function pipelines, does not free
1102 the module provider.
1103 See llvm::PassManagerBase::~PassManagerBase. */
1104 void LLVMDisposePassManager(LLVMPassManagerRef PM);
1112 class PassManagerBase;
1114 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1115 inline ty *unwrap(ref P) { \
1116 return reinterpret_cast<ty*>(P); \
1119 inline ref wrap(const ty *P) { \
1120 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1123 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1124 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1126 template<typename T> \
1127 inline T *unwrap(ref P) { \
1128 return cast<T>(unwrap(P)); \
1131 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1132 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1134 template<typename T> \
1135 inline T *unwrap(ref P) { \
1136 T *Q = (T*)unwrap(P); \
1137 assert(Q && "Invalid cast!"); \
1141 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1142 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
1143 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1144 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
1145 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
1146 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
1147 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
1148 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
1149 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
1150 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
1151 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1154 inline Module *unwrap(LLVMModuleProviderRef MP) {
1155 return reinterpret_cast<Module*>(MP);
1158 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1159 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
1160 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
1162 /* Specialized opaque context conversions.
1164 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1165 return reinterpret_cast<LLVMContext**>(Tys);
1168 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1169 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1172 /* Specialized opaque type conversions.
1174 inline Type **unwrap(LLVMTypeRef* Tys) {
1175 return reinterpret_cast<Type**>(Tys);
1178 inline LLVMTypeRef *wrap(Type **Tys) {
1179 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1182 /* Specialized opaque value conversions.
1184 inline Value **unwrap(LLVMValueRef *Vals) {
1185 return reinterpret_cast<Value**>(Vals);
1188 template<typename T>
1189 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1191 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
1195 return reinterpret_cast<T**>(Vals);
1198 inline LLVMValueRef *wrap(const Value **Vals) {
1199 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1203 #endif /* !defined(__cplusplus) */
1205 #endif /* !defined(LLVM_C_CORE_H) */