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/System/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/Support/IRBuilder.h"
54 * The top-level container for all LLVM global data. See the LLVMContext class.
56 typedef struct LLVMOpaqueContext *LLVMContextRef;
59 * The top-level container for all other LLVM Intermediate Representation (IR)
60 * objects. See the llvm::Module class.
62 typedef struct LLVMOpaqueModule *LLVMModuleRef;
65 * Each value in the LLVM IR has a type, an LLVMTypeRef. See the llvm::Type
68 typedef struct LLVMOpaqueType *LLVMTypeRef;
71 * When building recursive types using LLVMRefineType, LLVMTypeRef values may
72 * become invalid; use LLVMTypeHandleRef to resolve this problem. See the
73 * llvm::AbstractTypeHolder class.
75 typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef;
77 typedef struct LLVMOpaqueValue *LLVMValueRef;
78 typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
79 typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
81 /* Interface used to provide a module to JIT or interpreter. This is now just a
82 * synonym for llvm::Module, but we have to keep using the different type to
83 * keep binary compatibility.
85 typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
87 /* Used to provide a module to JIT or interpreter.
88 * See the llvm::MemoryBuffer class.
90 typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
92 /** See the llvm::PassManagerBase class. */
93 typedef struct LLVMOpaquePassManager *LLVMPassManagerRef;
96 * Used to iterate through the uses of a Value, allowing access to all Values
97 * that use this Value. See the llvm::Use and llvm::value_use_iterator classes.
99 typedef struct LLVMOpaqueUseIterator *LLVMUseIteratorRef;
102 LLVMZExtAttribute = 1<<0,
103 LLVMSExtAttribute = 1<<1,
104 LLVMNoReturnAttribute = 1<<2,
105 LLVMInRegAttribute = 1<<3,
106 LLVMStructRetAttribute = 1<<4,
107 LLVMNoUnwindAttribute = 1<<5,
108 LLVMNoAliasAttribute = 1<<6,
109 LLVMByValAttribute = 1<<7,
110 LLVMNestAttribute = 1<<8,
111 LLVMReadNoneAttribute = 1<<9,
112 LLVMReadOnlyAttribute = 1<<10,
113 LLVMNoInlineAttribute = 1<<11,
114 LLVMAlwaysInlineAttribute = 1<<12,
115 LLVMOptimizeForSizeAttribute = 1<<13,
116 LLVMStackProtectAttribute = 1<<14,
117 LLVMStackProtectReqAttribute = 1<<15,
118 LLVMNoCaptureAttribute = 1<<21,
119 LLVMNoRedZoneAttribute = 1<<22,
120 LLVMNoImplicitFloatAttribute = 1<<23,
121 LLVMNakedAttribute = 1<<24,
122 LLVMInlineHintAttribute = 1<<25
126 /* Terminator Instructions */
135 /* Standard Binary Operators */
149 /* Logical Operators */
157 /* Memory Operators */
161 LLVMGetElementPtr = 29,
177 /* Other Operators */
186 LLVMExtractElement = 50,
187 LLVMInsertElement = 51,
188 LLVMShuffleVector = 52,
189 LLVMExtractValue = 53,
194 LLVMVoidTypeKind, /**< type with no size */
195 LLVMFloatTypeKind, /**< 32 bit floating point type */
196 LLVMDoubleTypeKind, /**< 64 bit floating point type */
197 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
198 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
199 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
200 LLVMLabelTypeKind, /**< Labels */
201 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
202 LLVMFunctionTypeKind, /**< Functions */
203 LLVMStructTypeKind, /**< Structures */
204 LLVMArrayTypeKind, /**< Arrays */
205 LLVMPointerTypeKind, /**< Pointers */
206 LLVMOpaqueTypeKind, /**< Opaque: type with unknown structure */
207 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
208 LLVMMetadataTypeKind, /**< Metadata */
209 LLVMUnionTypeKind /**< Unions */
213 LLVMExternalLinkage, /**< Externally visible function */
214 LLVMAvailableExternallyLinkage,
215 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
216 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
218 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
219 LLVMWeakODRLinkage, /**< Same, but only replaced by something
221 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
222 LLVMInternalLinkage, /**< Rename collisions when linking (static
224 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
225 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
226 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
227 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
228 LLVMGhostLinkage, /**< Obsolete */
229 LLVMCommonLinkage, /**< Tentative definitions */
230 LLVMLinkerPrivateLinkage /**< Like Private, but linker removes. */
234 LLVMDefaultVisibility, /**< The GV is visible */
235 LLVMHiddenVisibility, /**< The GV is hidden */
236 LLVMProtectedVisibility /**< The GV is protected */
241 LLVMFastCallConv = 8,
242 LLVMColdCallConv = 9,
243 LLVMX86StdcallCallConv = 64,
244 LLVMX86FastcallCallConv = 65
248 LLVMIntEQ = 32, /**< equal */
249 LLVMIntNE, /**< not equal */
250 LLVMIntUGT, /**< unsigned greater than */
251 LLVMIntUGE, /**< unsigned greater or equal */
252 LLVMIntULT, /**< unsigned less than */
253 LLVMIntULE, /**< unsigned less or equal */
254 LLVMIntSGT, /**< signed greater than */
255 LLVMIntSGE, /**< signed greater or equal */
256 LLVMIntSLT, /**< signed less than */
257 LLVMIntSLE /**< signed less or equal */
261 LLVMRealPredicateFalse, /**< Always false (always folded) */
262 LLVMRealOEQ, /**< True if ordered and equal */
263 LLVMRealOGT, /**< True if ordered and greater than */
264 LLVMRealOGE, /**< True if ordered and greater than or equal */
265 LLVMRealOLT, /**< True if ordered and less than */
266 LLVMRealOLE, /**< True if ordered and less than or equal */
267 LLVMRealONE, /**< True if ordered and operands are unequal */
268 LLVMRealORD, /**< True if ordered (no nans) */
269 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
270 LLVMRealUEQ, /**< True if unordered or equal */
271 LLVMRealUGT, /**< True if unordered or greater than */
272 LLVMRealUGE, /**< True if unordered, greater than, or equal */
273 LLVMRealULT, /**< True if unordered or less than */
274 LLVMRealULE, /**< True if unordered, less than, or equal */
275 LLVMRealUNE, /**< True if unordered or not equal */
276 LLVMRealPredicateTrue /**< Always true (always folded) */
280 /*===-- Error handling ----------------------------------------------------===*/
282 void LLVMDisposeMessage(char *Message);
285 /*===-- Contexts ----------------------------------------------------------===*/
287 /* Create and destroy contexts. */
288 LLVMContextRef LLVMContextCreate(void);
289 LLVMContextRef LLVMGetGlobalContext(void);
290 void LLVMContextDispose(LLVMContextRef C);
292 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
294 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
296 /*===-- Modules -----------------------------------------------------------===*/
298 /* Create and destroy modules. */
299 /** See llvm::Module::Module. */
300 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
301 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
304 /** See llvm::Module::~Module. */
305 void LLVMDisposeModule(LLVMModuleRef M);
307 /** Data layout. See Module::getDataLayout. */
308 const char *LLVMGetDataLayout(LLVMModuleRef M);
309 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
311 /** Target triple. See Module::getTargetTriple. */
312 const char *LLVMGetTarget(LLVMModuleRef M);
313 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
315 /** See Module::addTypeName. */
316 LLVMBool LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
317 void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
318 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
320 /** See Module::dump. */
321 void LLVMDumpModule(LLVMModuleRef M);
324 /*===-- Types -------------------------------------------------------------===*/
326 /* LLVM types conform to the following hierarchy:
341 /** See llvm::LLVMTypeKind::getTypeID. */
342 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
344 /** See llvm::LLVMType::getContext. */
345 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
347 /* Operations on integer types */
348 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
349 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
350 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
351 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
352 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
353 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
355 LLVMTypeRef LLVMInt1Type(void);
356 LLVMTypeRef LLVMInt8Type(void);
357 LLVMTypeRef LLVMInt16Type(void);
358 LLVMTypeRef LLVMInt32Type(void);
359 LLVMTypeRef LLVMInt64Type(void);
360 LLVMTypeRef LLVMIntType(unsigned NumBits);
361 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
363 /* Operations on real types */
364 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
365 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
366 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
367 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
368 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
370 LLVMTypeRef LLVMFloatType(void);
371 LLVMTypeRef LLVMDoubleType(void);
372 LLVMTypeRef LLVMX86FP80Type(void);
373 LLVMTypeRef LLVMFP128Type(void);
374 LLVMTypeRef LLVMPPCFP128Type(void);
376 /* Operations on function types */
377 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
378 LLVMTypeRef *ParamTypes, unsigned ParamCount,
380 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
381 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
382 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
383 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
385 /* Operations on struct types */
386 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
387 unsigned ElementCount, LLVMBool Packed);
388 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
390 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
391 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
392 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
394 /* Operations on union types */
395 LLVMTypeRef LLVMUnionTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
396 unsigned ElementCount);
397 LLVMTypeRef LLVMUnionType(LLVMTypeRef *ElementTypes, unsigned ElementCount);
398 unsigned LLVMCountUnionElementTypes(LLVMTypeRef UnionTy);
399 void LLVMGetUnionElementTypes(LLVMTypeRef UnionTy, LLVMTypeRef *Dest);
401 /* Operations on array, pointer, and vector types (sequence types) */
402 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
403 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
404 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
406 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
407 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
408 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
409 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
411 /* Operations on other types */
412 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
413 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
414 LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
416 LLVMTypeRef LLVMVoidType(void);
417 LLVMTypeRef LLVMLabelType(void);
418 LLVMTypeRef LLVMOpaqueType(void);
420 /* Operations on type handles */
421 LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
422 void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
423 LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
424 void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
427 /*===-- Values ------------------------------------------------------------===*/
429 /* The bulk of LLVM's object model consists of values, which comprise a very
430 * rich type hierarchy.
433 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
439 macro(ConstantAggregateZero) \
440 macro(ConstantArray) \
441 macro(ConstantExpr) \
444 macro(ConstantPointerNull) \
445 macro(ConstantStruct) \
446 macro(ConstantVector) \
450 macro(GlobalVariable) \
453 macro(BinaryOperator) \
455 macro(IntrinsicInst) \
456 macro(DbgInfoIntrinsic) \
457 macro(DbgDeclareInst) \
458 macro(EHSelectorInst) \
459 macro(MemIntrinsic) \
466 macro(ExtractElementInst) \
467 macro(GetElementPtrInst) \
468 macro(InsertElementInst) \
469 macro(InsertValueInst) \
472 macro(ShuffleVectorInst) \
474 macro(TerminatorInst) \
479 macro(UnreachableInst) \
481 macro(UnaryInstruction) \
489 macro(IntToPtrInst) \
490 macro(PtrToIntInst) \
496 macro(ExtractValueInst) \
500 /* Operations on all values */
501 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
502 const char *LLVMGetValueName(LLVMValueRef Val);
503 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
504 void LLVMDumpValue(LLVMValueRef Val);
505 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
506 int LLVMHasMetadata(LLVMValueRef Val);
507 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
508 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
510 /* Conversion functions. Return the input value if it is an instance of the
511 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
512 #define LLVM_DECLARE_VALUE_CAST(name) \
513 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
514 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
516 /* Operations on Uses */
517 LLVMUseIteratorRef LLVMGetFirstUse(LLVMValueRef Val);
518 LLVMUseIteratorRef LLVMGetNextUse(LLVMUseIteratorRef U);
519 LLVMValueRef LLVMGetUser(LLVMUseIteratorRef U);
520 LLVMValueRef LLVMGetUsedValue(LLVMUseIteratorRef U);
522 /* Operations on Users */
523 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
525 /* Operations on constants of any type */
526 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
527 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
528 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
529 LLVMBool LLVMIsConstant(LLVMValueRef Val);
530 LLVMBool LLVMIsNull(LLVMValueRef Val);
531 LLVMBool LLVMIsUndef(LLVMValueRef Val);
532 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
534 /* Operations on metadata */
535 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
537 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
538 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
540 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
542 /* Operations on scalar constants */
543 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
544 LLVMBool SignExtend);
545 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
547 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
548 unsigned SLen, uint8_t Radix);
549 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
550 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
551 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
553 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
554 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
557 /* Operations on composite constants */
558 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
559 unsigned Length, LLVMBool DontNullTerminate);
560 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
561 LLVMValueRef *ConstantVals,
562 unsigned Count, LLVMBool Packed);
564 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
565 LLVMBool DontNullTerminate);
566 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
567 LLVMValueRef *ConstantVals, unsigned Length);
568 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
570 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
571 LLVMValueRef LLVMConstUnion(LLVMTypeRef Ty, LLVMValueRef Val);
573 /* Constant expressions */
574 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
575 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
576 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
577 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
578 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
579 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
580 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
581 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
582 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
583 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
584 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
585 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
586 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
587 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
588 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
589 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
590 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
591 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
592 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
593 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
594 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
595 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
596 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
597 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
598 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
599 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
600 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
601 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
602 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
604 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
605 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
606 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
607 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
609 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
610 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
611 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
612 LLVMValueRef *ConstantIndices, unsigned NumIndices);
613 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
614 LLVMValueRef *ConstantIndices,
615 unsigned NumIndices);
616 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
617 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
618 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
619 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
620 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
621 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
622 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
623 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
624 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
625 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
626 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
627 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
628 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
630 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
632 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
634 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
636 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
638 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
639 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
640 LLVMValueRef ConstantIfTrue,
641 LLVMValueRef ConstantIfFalse);
642 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
643 LLVMValueRef IndexConstant);
644 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
645 LLVMValueRef ElementValueConstant,
646 LLVMValueRef IndexConstant);
647 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
648 LLVMValueRef VectorBConstant,
649 LLVMValueRef MaskConstant);
650 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
652 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
653 LLVMValueRef ElementValueConstant,
654 unsigned *IdxList, unsigned NumIdx);
655 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
656 const char *AsmString, const char *Constraints,
657 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
659 /* Operations on global variables, functions, and aliases (globals) */
660 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
661 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
662 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
663 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
664 const char *LLVMGetSection(LLVMValueRef Global);
665 void LLVMSetSection(LLVMValueRef Global, const char *Section);
666 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
667 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
668 unsigned LLVMGetAlignment(LLVMValueRef Global);
669 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
671 /* Operations on global variables */
672 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
673 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
674 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
675 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
676 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
677 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
678 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
679 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
680 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
681 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
682 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
683 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
684 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
686 /* Operations on aliases */
687 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
690 /* Operations on functions */
691 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
692 LLVMTypeRef FunctionTy);
693 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
694 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
695 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
696 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
697 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
698 void LLVMDeleteFunction(LLVMValueRef Fn);
699 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
700 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
701 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
702 const char *LLVMGetGC(LLVMValueRef Fn);
703 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
704 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
705 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
706 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
708 /* Operations on parameters */
709 unsigned LLVMCountParams(LLVMValueRef Fn);
710 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
711 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
712 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
713 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
714 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
715 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
716 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
717 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
718 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
719 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
720 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
722 /* Operations on basic blocks */
723 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
724 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
725 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
726 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
727 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
728 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
729 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
730 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
731 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
732 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
733 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
735 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
738 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
739 LLVMBasicBlockRef BB,
742 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
743 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
745 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
747 /* Operations on instructions */
748 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
749 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
750 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
751 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
752 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
754 /* Operations on call sites */
755 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
756 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
757 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
758 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
760 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
763 /* Operations on call instructions (only) */
764 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
765 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
767 /* Operations on phi nodes */
768 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
769 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
770 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
771 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
772 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
774 /*===-- Instruction builders ----------------------------------------------===*/
776 /* An instruction builder represents a point within a basic block, and is the
777 * exclusive means of building instructions using the C interface.
780 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
781 LLVMBuilderRef LLVMCreateBuilder(void);
782 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
784 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
785 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
786 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
787 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
788 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
789 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
791 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
794 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
795 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
796 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
799 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
800 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
801 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
803 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
804 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
805 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
806 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
807 LLVMBasicBlockRef Else, unsigned NumCases);
808 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
809 LLVMValueRef *Args, unsigned NumArgs,
810 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
812 LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
813 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
815 /* Add a case to the switch instruction */
816 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
817 LLVMBasicBlockRef Dest);
820 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
822 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
824 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
826 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
828 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
830 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
832 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
834 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
836 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
838 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
840 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
842 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
844 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
846 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
848 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
850 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
852 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
854 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
856 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
858 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
860 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
862 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
864 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
866 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
868 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
870 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
871 LLVMValueRef LHS, LLVMValueRef RHS,
873 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
874 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
876 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
878 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
879 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
882 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
883 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
884 LLVMValueRef Val, const char *Name);
885 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
886 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
887 LLVMValueRef Val, const char *Name);
888 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
889 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
891 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
892 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
893 LLVMValueRef *Indices, unsigned NumIndices,
895 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
896 LLVMValueRef *Indices, unsigned NumIndices,
898 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
899 unsigned Idx, const char *Name);
900 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
902 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
906 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
907 LLVMTypeRef DestTy, const char *Name);
908 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
909 LLVMTypeRef DestTy, const char *Name);
910 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
911 LLVMTypeRef DestTy, const char *Name);
912 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
913 LLVMTypeRef DestTy, const char *Name);
914 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
915 LLVMTypeRef DestTy, const char *Name);
916 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
917 LLVMTypeRef DestTy, const char *Name);
918 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
919 LLVMTypeRef DestTy, const char *Name);
920 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
921 LLVMTypeRef DestTy, const char *Name);
922 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
923 LLVMTypeRef DestTy, const char *Name);
924 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
925 LLVMTypeRef DestTy, const char *Name);
926 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
927 LLVMTypeRef DestTy, const char *Name);
928 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
929 LLVMTypeRef DestTy, const char *Name);
930 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
931 LLVMTypeRef DestTy, const char *Name);
932 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
933 LLVMTypeRef DestTy, const char *Name);
934 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
935 LLVMTypeRef DestTy, const char *Name);
936 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
937 LLVMTypeRef DestTy, const char *Name);
938 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
939 LLVMTypeRef DestTy, const char *Name);
940 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
941 LLVMTypeRef DestTy, const char *Name);
942 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
943 LLVMTypeRef DestTy, const char *Name);
946 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
947 LLVMValueRef LHS, LLVMValueRef RHS,
949 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
950 LLVMValueRef LHS, LLVMValueRef RHS,
953 /* Miscellaneous instructions */
954 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
955 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
956 LLVMValueRef *Args, unsigned NumArgs,
958 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
959 LLVMValueRef Then, LLVMValueRef Else,
961 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
963 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
964 LLVMValueRef Index, const char *Name);
965 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
966 LLVMValueRef EltVal, LLVMValueRef Index,
968 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
969 LLVMValueRef V2, LLVMValueRef Mask,
971 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
972 unsigned Index, const char *Name);
973 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
974 LLVMValueRef EltVal, unsigned Index,
977 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
979 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
981 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
982 LLVMValueRef RHS, const char *Name);
985 /*===-- Module providers --------------------------------------------------===*/
987 /* Changes the type of M so it can be passed to FunctionPassManagers and the
988 * JIT. They take ModuleProviders for historical reasons.
990 LLVMModuleProviderRef
991 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
993 /* Destroys the module M.
995 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
998 /*===-- Memory buffers ----------------------------------------------------===*/
1000 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1001 LLVMMemoryBufferRef *OutMemBuf,
1003 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1005 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1008 /*===-- Pass Managers -----------------------------------------------------===*/
1010 /** Constructs a new whole-module pass pipeline. This type of pipeline is
1011 suitable for link-time optimization and whole-module transformations.
1012 See llvm::PassManager::PassManager. */
1013 LLVMPassManagerRef LLVMCreatePassManager(void);
1015 /** Constructs a new function-by-function pass pipeline over the module
1016 provider. It does not take ownership of the module provider. This type of
1017 pipeline is suitable for code generation and JIT compilation tasks.
1018 See llvm::FunctionPassManager::FunctionPassManager. */
1019 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1021 /** Initializes, executes on the provided module, and finalizes all of the
1022 passes scheduled in the pass manager. Returns 1 if any of the passes
1023 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
1024 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
1026 /** Initializes all of the function passes scheduled in the function pass
1027 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1028 See llvm::FunctionPassManager::doInitialization. */
1029 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
1031 /** Executes all of the function passes scheduled in the function pass manager
1032 on the provided function. Returns 1 if any of the passes modified the
1033 function, false otherwise.
1034 See llvm::FunctionPassManager::run(Function&). */
1035 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
1037 /** Finalizes all of the function passes scheduled in in the function pass
1038 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1039 See llvm::FunctionPassManager::doFinalization. */
1040 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
1042 /** Frees the memory of a pass pipeline. For function pipelines, does not free
1043 the module provider.
1044 See llvm::PassManagerBase::~PassManagerBase. */
1045 void LLVMDisposePassManager(LLVMPassManagerRef PM);
1053 class PassManagerBase;
1055 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1056 inline ty *unwrap(ref P) { \
1057 return reinterpret_cast<ty*>(P); \
1060 inline ref wrap(const ty *P) { \
1061 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1064 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1065 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1067 template<typename T> \
1068 inline T *unwrap(ref P) { \
1069 return cast<T>(unwrap(P)); \
1072 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1073 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1075 template<typename T> \
1076 inline T *unwrap(ref P) { \
1077 T *Q = (T*)unwrap(P); \
1078 assert(Q && "Invalid cast!"); \
1082 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1083 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
1084 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1085 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
1086 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
1087 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
1088 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
1089 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
1090 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseIteratorRef )
1091 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
1092 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1095 inline Module *unwrap(LLVMModuleProviderRef MP) {
1096 return reinterpret_cast<Module*>(MP);
1099 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1100 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
1101 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
1103 /* Specialized opaque context conversions.
1105 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1106 return reinterpret_cast<LLVMContext**>(Tys);
1109 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1110 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1113 /* Specialized opaque type conversions.
1115 inline Type **unwrap(LLVMTypeRef* Tys) {
1116 return reinterpret_cast<Type**>(Tys);
1119 inline LLVMTypeRef *wrap(const Type **Tys) {
1120 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1123 /* Specialized opaque value conversions.
1125 inline Value **unwrap(LLVMValueRef *Vals) {
1126 return reinterpret_cast<Value**>(Vals);
1129 template<typename T>
1130 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1132 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
1135 return reinterpret_cast<T**>(Vals);
1138 inline LLVMValueRef *wrap(const Value **Vals) {
1139 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1143 #endif /* !defined(__cplusplus) */
1145 #endif /* !defined(LLVM_C_CORE_H) */