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;
95 /** Used to get the users and usees of a Value. See the llvm::Use class. */
96 typedef struct LLVMOpaqueUse *LLVMUseRef;
99 LLVMZExtAttribute = 1<<0,
100 LLVMSExtAttribute = 1<<1,
101 LLVMNoReturnAttribute = 1<<2,
102 LLVMInRegAttribute = 1<<3,
103 LLVMStructRetAttribute = 1<<4,
104 LLVMNoUnwindAttribute = 1<<5,
105 LLVMNoAliasAttribute = 1<<6,
106 LLVMByValAttribute = 1<<7,
107 LLVMNestAttribute = 1<<8,
108 LLVMReadNoneAttribute = 1<<9,
109 LLVMReadOnlyAttribute = 1<<10,
110 LLVMNoInlineAttribute = 1<<11,
111 LLVMAlwaysInlineAttribute = 1<<12,
112 LLVMOptimizeForSizeAttribute = 1<<13,
113 LLVMStackProtectAttribute = 1<<14,
114 LLVMStackProtectReqAttribute = 1<<15,
115 LLVMNoCaptureAttribute = 1<<21,
116 LLVMNoRedZoneAttribute = 1<<22,
117 LLVMNoImplicitFloatAttribute = 1<<23,
118 LLVMNakedAttribute = 1<<24,
119 LLVMInlineHintAttribute = 1<<25
123 /* Terminator Instructions */
132 /* Standard Binary Operators */
146 /* Logical Operators */
154 /* Memory Operators */
158 LLVMGetElementPtr = 29,
174 /* Other Operators */
183 LLVMExtractElement = 50,
184 LLVMInsertElement = 51,
185 LLVMShuffleVector = 52,
186 LLVMExtractValue = 53,
191 LLVMVoidTypeKind, /**< type with no size */
192 LLVMFloatTypeKind, /**< 32 bit floating point type */
193 LLVMDoubleTypeKind, /**< 64 bit floating point type */
194 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
195 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
196 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
197 LLVMLabelTypeKind, /**< Labels */
198 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
199 LLVMFunctionTypeKind, /**< Functions */
200 LLVMStructTypeKind, /**< Structures */
201 LLVMArrayTypeKind, /**< Arrays */
202 LLVMPointerTypeKind, /**< Pointers */
203 LLVMOpaqueTypeKind, /**< Opaque: type with unknown structure */
204 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
205 LLVMMetadataTypeKind, /**< Metadata */
206 LLVMUnionTypeKind /**< Unions */
210 LLVMExternalLinkage, /**< Externally visible function */
211 LLVMAvailableExternallyLinkage,
212 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
213 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
215 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
216 LLVMWeakODRLinkage, /**< Same, but only replaced by something
218 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
219 LLVMInternalLinkage, /**< Rename collisions when linking (static
221 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
222 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
223 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
224 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
225 LLVMGhostLinkage, /**< Obsolete */
226 LLVMCommonLinkage, /**< Tentative definitions */
227 LLVMLinkerPrivateLinkage /**< Like Private, but linker removes. */
231 LLVMDefaultVisibility, /**< The GV is visible */
232 LLVMHiddenVisibility, /**< The GV is hidden */
233 LLVMProtectedVisibility /**< The GV is protected */
238 LLVMFastCallConv = 8,
239 LLVMColdCallConv = 9,
240 LLVMX86StdcallCallConv = 64,
241 LLVMX86FastcallCallConv = 65
245 LLVMIntEQ = 32, /**< equal */
246 LLVMIntNE, /**< not equal */
247 LLVMIntUGT, /**< unsigned greater than */
248 LLVMIntUGE, /**< unsigned greater or equal */
249 LLVMIntULT, /**< unsigned less than */
250 LLVMIntULE, /**< unsigned less or equal */
251 LLVMIntSGT, /**< signed greater than */
252 LLVMIntSGE, /**< signed greater or equal */
253 LLVMIntSLT, /**< signed less than */
254 LLVMIntSLE /**< signed less or equal */
258 LLVMRealPredicateFalse, /**< Always false (always folded) */
259 LLVMRealOEQ, /**< True if ordered and equal */
260 LLVMRealOGT, /**< True if ordered and greater than */
261 LLVMRealOGE, /**< True if ordered and greater than or equal */
262 LLVMRealOLT, /**< True if ordered and less than */
263 LLVMRealOLE, /**< True if ordered and less than or equal */
264 LLVMRealONE, /**< True if ordered and operands are unequal */
265 LLVMRealORD, /**< True if ordered (no nans) */
266 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
267 LLVMRealUEQ, /**< True if unordered or equal */
268 LLVMRealUGT, /**< True if unordered or greater than */
269 LLVMRealUGE, /**< True if unordered, greater than, or equal */
270 LLVMRealULT, /**< True if unordered or less than */
271 LLVMRealULE, /**< True if unordered, less than, or equal */
272 LLVMRealUNE, /**< True if unordered or not equal */
273 LLVMRealPredicateTrue /**< Always true (always folded) */
277 /*===-- Error handling ----------------------------------------------------===*/
279 void LLVMDisposeMessage(char *Message);
282 /*===-- Contexts ----------------------------------------------------------===*/
284 /* Create and destroy contexts. */
285 LLVMContextRef LLVMContextCreate(void);
286 LLVMContextRef LLVMGetGlobalContext(void);
287 void LLVMContextDispose(LLVMContextRef C);
289 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
291 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
293 /*===-- Modules -----------------------------------------------------------===*/
295 /* Create and destroy modules. */
296 /** See llvm::Module::Module. */
297 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
298 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
301 /** See llvm::Module::~Module. */
302 void LLVMDisposeModule(LLVMModuleRef M);
304 /** Data layout. See Module::getDataLayout. */
305 const char *LLVMGetDataLayout(LLVMModuleRef M);
306 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
308 /** Target triple. See Module::getTargetTriple. */
309 const char *LLVMGetTarget(LLVMModuleRef M);
310 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
312 /** See Module::addTypeName. */
313 LLVMBool LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
314 void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
315 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
317 /** See Module::dump. */
318 void LLVMDumpModule(LLVMModuleRef M);
321 /*===-- Types -------------------------------------------------------------===*/
323 /* LLVM types conform to the following hierarchy:
338 /** See llvm::LLVMTypeKind::getTypeID. */
339 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
341 /** See llvm::LLVMType::getContext. */
342 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
344 /* Operations on integer types */
345 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
346 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
347 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
348 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
349 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
350 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
352 LLVMTypeRef LLVMInt1Type(void);
353 LLVMTypeRef LLVMInt8Type(void);
354 LLVMTypeRef LLVMInt16Type(void);
355 LLVMTypeRef LLVMInt32Type(void);
356 LLVMTypeRef LLVMInt64Type(void);
357 LLVMTypeRef LLVMIntType(unsigned NumBits);
358 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
360 /* Operations on real types */
361 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
362 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
363 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
364 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
365 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
367 LLVMTypeRef LLVMFloatType(void);
368 LLVMTypeRef LLVMDoubleType(void);
369 LLVMTypeRef LLVMX86FP80Type(void);
370 LLVMTypeRef LLVMFP128Type(void);
371 LLVMTypeRef LLVMPPCFP128Type(void);
373 /* Operations on function types */
374 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
375 LLVMTypeRef *ParamTypes, unsigned ParamCount,
377 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
378 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
379 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
380 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
382 /* Operations on struct types */
383 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
384 unsigned ElementCount, LLVMBool Packed);
385 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
387 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
388 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
389 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
391 /* Operations on union types */
392 LLVMTypeRef LLVMUnionTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
393 unsigned ElementCount);
394 LLVMTypeRef LLVMUnionType(LLVMTypeRef *ElementTypes, unsigned ElementCount);
395 unsigned LLVMCountUnionElementTypes(LLVMTypeRef UnionTy);
396 void LLVMGetUnionElementTypes(LLVMTypeRef UnionTy, LLVMTypeRef *Dest);
398 /* Operations on array, pointer, and vector types (sequence types) */
399 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
400 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
401 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
403 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
404 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
405 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
406 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
408 /* Operations on other types */
409 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
410 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
411 LLVMTypeRef LLVMOpaqueTypeInContext(LLVMContextRef C);
413 LLVMTypeRef LLVMVoidType(void);
414 LLVMTypeRef LLVMLabelType(void);
415 LLVMTypeRef LLVMOpaqueType(void);
417 /* Operations on type handles */
418 LLVMTypeHandleRef LLVMCreateTypeHandle(LLVMTypeRef PotentiallyAbstractTy);
419 void LLVMRefineType(LLVMTypeRef AbstractTy, LLVMTypeRef ConcreteTy);
420 LLVMTypeRef LLVMResolveTypeHandle(LLVMTypeHandleRef TypeHandle);
421 void LLVMDisposeTypeHandle(LLVMTypeHandleRef TypeHandle);
424 /*===-- Values ------------------------------------------------------------===*/
426 /* The bulk of LLVM's object model consists of values, which comprise a very
427 * rich type hierarchy.
430 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
436 macro(ConstantAggregateZero) \
437 macro(ConstantArray) \
438 macro(ConstantExpr) \
441 macro(ConstantPointerNull) \
442 macro(ConstantStruct) \
443 macro(ConstantVector) \
447 macro(GlobalVariable) \
450 macro(BinaryOperator) \
452 macro(IntrinsicInst) \
453 macro(DbgInfoIntrinsic) \
454 macro(DbgDeclareInst) \
455 macro(EHSelectorInst) \
456 macro(MemIntrinsic) \
463 macro(ExtractElementInst) \
464 macro(GetElementPtrInst) \
465 macro(InsertElementInst) \
466 macro(InsertValueInst) \
469 macro(ShuffleVectorInst) \
471 macro(TerminatorInst) \
476 macro(UnreachableInst) \
478 macro(UnaryInstruction) \
486 macro(IntToPtrInst) \
487 macro(PtrToIntInst) \
493 macro(ExtractValueInst) \
497 /* Operations on all values */
498 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
499 const char *LLVMGetValueName(LLVMValueRef Val);
500 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
501 void LLVMDumpValue(LLVMValueRef Val);
502 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
503 int LLVMHasMetadata(LLVMValueRef Val);
504 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
505 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
507 /* Conversion functions. Return the input value if it is an instance of the
508 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
509 #define LLVM_DECLARE_VALUE_CAST(name) \
510 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
511 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
513 /* Operations on Uses */
514 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
515 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
516 LLVMValueRef LLVMGetUser(LLVMUseRef U);
517 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
519 /* Operations on Users */
520 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
522 /* Operations on constants of any type */
523 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
524 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
525 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
526 LLVMBool LLVMIsConstant(LLVMValueRef Val);
527 LLVMBool LLVMIsNull(LLVMValueRef Val);
528 LLVMBool LLVMIsUndef(LLVMValueRef Val);
529 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
531 /* Operations on metadata */
532 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
534 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
535 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
537 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
539 /* Operations on scalar constants */
540 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
541 LLVMBool SignExtend);
542 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
544 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
545 unsigned SLen, uint8_t Radix);
546 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
547 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
548 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
550 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
551 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
554 /* Operations on composite constants */
555 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
556 unsigned Length, LLVMBool DontNullTerminate);
557 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
558 LLVMValueRef *ConstantVals,
559 unsigned Count, LLVMBool Packed);
561 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
562 LLVMBool DontNullTerminate);
563 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
564 LLVMValueRef *ConstantVals, unsigned Length);
565 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
567 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
568 LLVMValueRef LLVMConstUnion(LLVMTypeRef Ty, LLVMValueRef Val);
570 /* Constant expressions */
571 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
572 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
573 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
574 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
575 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
576 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
577 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
578 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
579 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
580 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
581 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
582 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
583 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
584 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
585 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
586 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
587 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
588 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
589 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
590 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
591 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
592 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
593 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
594 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
595 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
596 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
597 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
598 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
599 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
600 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
601 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
602 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
603 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
604 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
605 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
606 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
607 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
608 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
609 LLVMValueRef *ConstantIndices, unsigned NumIndices);
610 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
611 LLVMValueRef *ConstantIndices,
612 unsigned NumIndices);
613 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
614 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
615 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
616 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
617 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
618 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
619 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
620 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
621 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
622 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
623 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
624 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
625 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
627 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
629 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
631 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
633 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
635 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
636 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
637 LLVMValueRef ConstantIfTrue,
638 LLVMValueRef ConstantIfFalse);
639 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
640 LLVMValueRef IndexConstant);
641 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
642 LLVMValueRef ElementValueConstant,
643 LLVMValueRef IndexConstant);
644 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
645 LLVMValueRef VectorBConstant,
646 LLVMValueRef MaskConstant);
647 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
649 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
650 LLVMValueRef ElementValueConstant,
651 unsigned *IdxList, unsigned NumIdx);
652 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
653 const char *AsmString, const char *Constraints,
654 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
655 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
657 /* Operations on global variables, functions, and aliases (globals) */
658 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
659 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
660 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
661 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
662 const char *LLVMGetSection(LLVMValueRef Global);
663 void LLVMSetSection(LLVMValueRef Global, const char *Section);
664 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
665 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
666 unsigned LLVMGetAlignment(LLVMValueRef Global);
667 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
669 /* Operations on global variables */
670 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
671 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
673 unsigned AddressSpace);
674 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
675 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
676 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
677 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
678 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
679 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
680 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
681 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
682 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
683 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
684 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
685 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
687 /* Operations on aliases */
688 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
691 /* Operations on functions */
692 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
693 LLVMTypeRef FunctionTy);
694 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
695 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
696 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
697 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
698 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
699 void LLVMDeleteFunction(LLVMValueRef Fn);
700 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
701 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
702 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
703 const char *LLVMGetGC(LLVMValueRef Fn);
704 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
705 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
706 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
707 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
709 /* Operations on parameters */
710 unsigned LLVMCountParams(LLVMValueRef Fn);
711 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
712 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
713 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
714 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
715 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
716 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
717 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
718 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
719 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
720 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
721 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
723 /* Operations on basic blocks */
724 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
725 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
726 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
727 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
728 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
729 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
730 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
731 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
732 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
733 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
734 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
736 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
739 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
740 LLVMBasicBlockRef BB,
743 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
744 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
746 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
748 /* Operations on instructions */
749 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
750 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
751 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
752 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
753 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
755 /* Operations on call sites */
756 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
757 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
758 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
759 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
761 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
764 /* Operations on call instructions (only) */
765 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
766 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
768 /* Operations on phi nodes */
769 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
770 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
771 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
772 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
773 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
775 /*===-- Instruction builders ----------------------------------------------===*/
777 /* An instruction builder represents a point within a basic block, and is the
778 * exclusive means of building instructions using the C interface.
781 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
782 LLVMBuilderRef LLVMCreateBuilder(void);
783 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
785 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
786 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
787 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
788 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
789 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
790 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
792 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
795 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
796 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
797 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
800 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
801 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
802 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
804 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
805 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
806 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
807 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
808 LLVMBasicBlockRef Else, unsigned NumCases);
809 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
811 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
812 LLVMValueRef *Args, unsigned NumArgs,
813 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
815 LLVMValueRef LLVMBuildUnwind(LLVMBuilderRef);
816 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
818 /* Add a case to the switch instruction */
819 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
820 LLVMBasicBlockRef Dest);
822 /* Add a destination to the indirectbr instruction */
823 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
826 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
828 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
830 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
832 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
834 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
836 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
838 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
840 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
842 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
844 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
846 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
848 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
850 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
852 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
854 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
856 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
858 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
860 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
862 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
864 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
866 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
868 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
870 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
872 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
874 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
876 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
877 LLVMValueRef LHS, LLVMValueRef RHS,
879 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
880 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
882 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
884 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
885 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
888 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
889 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
890 LLVMValueRef Val, const char *Name);
891 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
892 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
893 LLVMValueRef Val, const char *Name);
894 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
895 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
897 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
898 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
899 LLVMValueRef *Indices, unsigned NumIndices,
901 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
902 LLVMValueRef *Indices, unsigned NumIndices,
904 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
905 unsigned Idx, const char *Name);
906 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
908 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
912 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
913 LLVMTypeRef DestTy, const char *Name);
914 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
915 LLVMTypeRef DestTy, const char *Name);
916 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
917 LLVMTypeRef DestTy, const char *Name);
918 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
919 LLVMTypeRef DestTy, const char *Name);
920 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
921 LLVMTypeRef DestTy, const char *Name);
922 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
923 LLVMTypeRef DestTy, const char *Name);
924 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
925 LLVMTypeRef DestTy, const char *Name);
926 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
927 LLVMTypeRef DestTy, const char *Name);
928 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
929 LLVMTypeRef DestTy, const char *Name);
930 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
931 LLVMTypeRef DestTy, const char *Name);
932 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
933 LLVMTypeRef DestTy, const char *Name);
934 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
935 LLVMTypeRef DestTy, const char *Name);
936 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
937 LLVMTypeRef DestTy, const char *Name);
938 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
939 LLVMTypeRef DestTy, const char *Name);
940 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
941 LLVMTypeRef DestTy, const char *Name);
942 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
943 LLVMTypeRef DestTy, const char *Name);
944 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
945 LLVMTypeRef DestTy, const char *Name);
946 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
947 LLVMTypeRef DestTy, const char *Name);
948 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
949 LLVMTypeRef DestTy, const char *Name);
952 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
953 LLVMValueRef LHS, LLVMValueRef RHS,
955 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
956 LLVMValueRef LHS, LLVMValueRef RHS,
959 /* Miscellaneous instructions */
960 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
961 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
962 LLVMValueRef *Args, unsigned NumArgs,
964 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
965 LLVMValueRef Then, LLVMValueRef Else,
967 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
969 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
970 LLVMValueRef Index, const char *Name);
971 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
972 LLVMValueRef EltVal, LLVMValueRef Index,
974 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
975 LLVMValueRef V2, LLVMValueRef Mask,
977 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
978 unsigned Index, const char *Name);
979 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
980 LLVMValueRef EltVal, unsigned Index,
983 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
985 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
987 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
988 LLVMValueRef RHS, const char *Name);
991 /*===-- Module providers --------------------------------------------------===*/
993 /* Changes the type of M so it can be passed to FunctionPassManagers and the
994 * JIT. They take ModuleProviders for historical reasons.
996 LLVMModuleProviderRef
997 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
999 /* Destroys the module M.
1001 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
1004 /*===-- Memory buffers ----------------------------------------------------===*/
1006 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1007 LLVMMemoryBufferRef *OutMemBuf,
1009 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1011 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1014 /*===-- Pass Managers -----------------------------------------------------===*/
1016 /** Constructs a new whole-module pass pipeline. This type of pipeline is
1017 suitable for link-time optimization and whole-module transformations.
1018 See llvm::PassManager::PassManager. */
1019 LLVMPassManagerRef LLVMCreatePassManager(void);
1021 /** Constructs a new function-by-function pass pipeline over the module
1022 provider. It does not take ownership of the module provider. This type of
1023 pipeline is suitable for code generation and JIT compilation tasks.
1024 See llvm::FunctionPassManager::FunctionPassManager. */
1025 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1027 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
1028 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1030 /** Initializes, executes on the provided module, and finalizes all of the
1031 passes scheduled in the pass manager. Returns 1 if any of the passes
1032 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
1033 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
1035 /** Initializes all of the function passes scheduled in the function pass
1036 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1037 See llvm::FunctionPassManager::doInitialization. */
1038 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
1040 /** Executes all of the function passes scheduled in the function pass manager
1041 on the provided function. Returns 1 if any of the passes modified the
1042 function, false otherwise.
1043 See llvm::FunctionPassManager::run(Function&). */
1044 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
1046 /** Finalizes all of the function passes scheduled in in the function pass
1047 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1048 See llvm::FunctionPassManager::doFinalization. */
1049 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
1051 /** Frees the memory of a pass pipeline. For function pipelines, does not free
1052 the module provider.
1053 See llvm::PassManagerBase::~PassManagerBase. */
1054 void LLVMDisposePassManager(LLVMPassManagerRef PM);
1062 class PassManagerBase;
1064 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1065 inline ty *unwrap(ref P) { \
1066 return reinterpret_cast<ty*>(P); \
1069 inline ref wrap(const ty *P) { \
1070 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1073 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1074 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1076 template<typename T> \
1077 inline T *unwrap(ref P) { \
1078 return cast<T>(unwrap(P)); \
1081 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1082 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1084 template<typename T> \
1085 inline T *unwrap(ref P) { \
1086 T *Q = (T*)unwrap(P); \
1087 assert(Q && "Invalid cast!"); \
1091 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1092 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
1093 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1094 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
1095 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
1096 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(PATypeHolder, LLVMTypeHandleRef )
1097 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
1098 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
1099 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
1100 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
1101 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1104 inline Module *unwrap(LLVMModuleProviderRef MP) {
1105 return reinterpret_cast<Module*>(MP);
1108 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1109 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
1110 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
1112 /* Specialized opaque context conversions.
1114 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1115 return reinterpret_cast<LLVMContext**>(Tys);
1118 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1119 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1122 /* Specialized opaque type conversions.
1124 inline Type **unwrap(LLVMTypeRef* Tys) {
1125 return reinterpret_cast<Type**>(Tys);
1128 inline LLVMTypeRef *wrap(const Type **Tys) {
1129 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1132 /* Specialized opaque value conversions.
1134 inline Value **unwrap(LLVMValueRef *Vals) {
1135 return reinterpret_cast<Value**>(Vals);
1138 template<typename T>
1139 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1141 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
1144 return reinterpret_cast<T**>(Vals);
1147 inline LLVMValueRef *wrap(const Value **Vals) {
1148 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1152 #endif /* !defined(__cplusplus) */
1154 #endif /* !defined(LLVM_C_CORE_H) */