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,
119 LLVMReturnsTwice = 1 << 29,
120 LLVMUWTable = 1 << 30,
121 LLVMNonLazyBind = 1 << 31
125 /* Terminator Instructions */
131 /* removed 6 due to API changes */
134 /* Standard Binary Operators */
148 /* Logical Operators */
156 /* Memory Operators */
160 LLVMGetElementPtr = 29,
176 /* Other Operators */
185 LLVMExtractElement = 50,
186 LLVMInsertElement = 51,
187 LLVMShuffleVector = 52,
188 LLVMExtractValue = 53,
189 LLVMInsertValue = 54,
191 /* Atomic operators */
193 LLVMAtomicCmpXchg = 56,
196 /* Exception Handling Operators */
205 LLVMVoidTypeKind, /**< type with no size */
206 LLVMFloatTypeKind, /**< 32 bit floating point type */
207 LLVMDoubleTypeKind, /**< 64 bit floating point type */
208 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
209 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
210 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
211 LLVMLabelTypeKind, /**< Labels */
212 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
213 LLVMFunctionTypeKind, /**< Functions */
214 LLVMStructTypeKind, /**< Structures */
215 LLVMArrayTypeKind, /**< Arrays */
216 LLVMPointerTypeKind, /**< Pointers */
217 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */
218 LLVMMetadataTypeKind, /**< Metadata */
219 LLVMX86_MMXTypeKind /**< X86 MMX */
223 LLVMExternalLinkage, /**< Externally visible function */
224 LLVMAvailableExternallyLinkage,
225 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/
226 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something
228 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */
229 LLVMWeakODRLinkage, /**< Same, but only replaced by something
231 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
232 LLVMInternalLinkage, /**< Rename collisions when linking (static
234 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */
235 LLVMDLLImportLinkage, /**< Function to be imported from DLL */
236 LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
237 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
238 LLVMGhostLinkage, /**< Obsolete */
239 LLVMCommonLinkage, /**< Tentative definitions */
240 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */
241 LLVMLinkerPrivateWeakLinkage, /**< Like LinkerPrivate, but is weak. */
242 LLVMLinkerPrivateWeakDefAutoLinkage /**< Like LinkerPrivateWeak, but possibly
247 LLVMDefaultVisibility, /**< The GV is visible */
248 LLVMHiddenVisibility, /**< The GV is hidden */
249 LLVMProtectedVisibility /**< The GV is protected */
254 LLVMFastCallConv = 8,
255 LLVMColdCallConv = 9,
256 LLVMX86StdcallCallConv = 64,
257 LLVMX86FastcallCallConv = 65
261 LLVMIntEQ = 32, /**< equal */
262 LLVMIntNE, /**< not equal */
263 LLVMIntUGT, /**< unsigned greater than */
264 LLVMIntUGE, /**< unsigned greater or equal */
265 LLVMIntULT, /**< unsigned less than */
266 LLVMIntULE, /**< unsigned less or equal */
267 LLVMIntSGT, /**< signed greater than */
268 LLVMIntSGE, /**< signed greater or equal */
269 LLVMIntSLT, /**< signed less than */
270 LLVMIntSLE /**< signed less or equal */
274 LLVMRealPredicateFalse, /**< Always false (always folded) */
275 LLVMRealOEQ, /**< True if ordered and equal */
276 LLVMRealOGT, /**< True if ordered and greater than */
277 LLVMRealOGE, /**< True if ordered and greater than or equal */
278 LLVMRealOLT, /**< True if ordered and less than */
279 LLVMRealOLE, /**< True if ordered and less than or equal */
280 LLVMRealONE, /**< True if ordered and operands are unequal */
281 LLVMRealORD, /**< True if ordered (no nans) */
282 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
283 LLVMRealUEQ, /**< True if unordered or equal */
284 LLVMRealUGT, /**< True if unordered or greater than */
285 LLVMRealUGE, /**< True if unordered, greater than, or equal */
286 LLVMRealULT, /**< True if unordered or less than */
287 LLVMRealULE, /**< True if unordered, less than, or equal */
288 LLVMRealUNE, /**< True if unordered or not equal */
289 LLVMRealPredicateTrue /**< Always true (always folded) */
293 LLVMLandingPadCatch, /**< A catch clause */
294 LLVMLandingPadFilter /**< A filter clause */
295 } LLVMLandingPadClauseTy;
297 void LLVMInitializeCore(LLVMPassRegistryRef R);
300 /*===-- Error handling ----------------------------------------------------===*/
302 void LLVMDisposeMessage(char *Message);
305 /*===-- Contexts ----------------------------------------------------------===*/
307 /* Create and destroy contexts. */
308 LLVMContextRef LLVMContextCreate(void);
309 LLVMContextRef LLVMGetGlobalContext(void);
310 void LLVMContextDispose(LLVMContextRef C);
312 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name,
314 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen);
316 /*===-- Modules -----------------------------------------------------------===*/
318 /* Create and destroy modules. */
319 /** See llvm::Module::Module. */
320 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
321 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID,
324 /** See llvm::Module::~Module. */
325 void LLVMDisposeModule(LLVMModuleRef M);
327 /** Data layout. See Module::getDataLayout. */
328 const char *LLVMGetDataLayout(LLVMModuleRef M);
329 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
331 /** Target triple. See Module::getTargetTriple. */
332 const char *LLVMGetTarget(LLVMModuleRef M);
333 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
335 /** See Module::dump. */
336 void LLVMDumpModule(LLVMModuleRef M);
338 /** See Module::setModuleInlineAsm. */
339 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm);
341 /** See Module::getContext. */
342 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M);
344 /*===-- Types -------------------------------------------------------------===*/
346 /* LLVM types conform to the following hierarchy:
361 /** See llvm::LLVMTypeKind::getTypeID. */
362 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
363 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty);
365 /** See llvm::LLVMType::getContext. */
366 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty);
368 /* Operations on integer types */
369 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C);
370 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C);
371 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C);
372 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C);
373 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C);
374 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits);
376 LLVMTypeRef LLVMInt1Type(void);
377 LLVMTypeRef LLVMInt8Type(void);
378 LLVMTypeRef LLVMInt16Type(void);
379 LLVMTypeRef LLVMInt32Type(void);
380 LLVMTypeRef LLVMInt64Type(void);
381 LLVMTypeRef LLVMIntType(unsigned NumBits);
382 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy);
384 /* Operations on real types */
385 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C);
386 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C);
387 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C);
388 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C);
389 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C);
391 LLVMTypeRef LLVMFloatType(void);
392 LLVMTypeRef LLVMDoubleType(void);
393 LLVMTypeRef LLVMX86FP80Type(void);
394 LLVMTypeRef LLVMFP128Type(void);
395 LLVMTypeRef LLVMPPCFP128Type(void);
397 /* Operations on function types */
398 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType,
399 LLVMTypeRef *ParamTypes, unsigned ParamCount,
401 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy);
402 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy);
403 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy);
404 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest);
406 /* Operations on struct types */
407 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes,
408 unsigned ElementCount, LLVMBool Packed);
409 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount,
411 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name);
412 const char *LLVMGetStructName(LLVMTypeRef Ty);
413 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes,
414 unsigned ElementCount, LLVMBool Packed);
416 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy);
417 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest);
418 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy);
419 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy);
421 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name);
423 /* Operations on array, pointer, and vector types (sequence types) */
424 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount);
425 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace);
426 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount);
428 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty);
429 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy);
430 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy);
431 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy);
433 /* Operations on other types */
434 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C);
435 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C);
436 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C);
438 LLVMTypeRef LLVMVoidType(void);
439 LLVMTypeRef LLVMLabelType(void);
440 LLVMTypeRef LLVMX86MMXType(void);
442 /*===-- Values ------------------------------------------------------------===*/
444 /* The bulk of LLVM's object model consists of values, which comprise a very
445 * rich type hierarchy.
448 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \
454 macro(ConstantAggregateZero) \
455 macro(ConstantArray) \
456 macro(ConstantExpr) \
459 macro(ConstantPointerNull) \
460 macro(ConstantStruct) \
461 macro(ConstantVector) \
465 macro(GlobalVariable) \
468 macro(BinaryOperator) \
470 macro(IntrinsicInst) \
471 macro(DbgInfoIntrinsic) \
472 macro(DbgDeclareInst) \
473 macro(EHSelectorInst) \
474 macro(MemIntrinsic) \
481 macro(ExtractElementInst) \
482 macro(GetElementPtrInst) \
483 macro(InsertElementInst) \
484 macro(InsertValueInst) \
485 macro(LandingPadInst) \
488 macro(ShuffleVectorInst) \
490 macro(TerminatorInst) \
495 macro(UnreachableInst) \
497 macro(UnaryInstruction) \
505 macro(IntToPtrInst) \
506 macro(PtrToIntInst) \
512 macro(ExtractValueInst) \
516 /* Operations on all values */
517 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val);
518 const char *LLVMGetValueName(LLVMValueRef Val);
519 void LLVMSetValueName(LLVMValueRef Val, const char *Name);
520 void LLVMDumpValue(LLVMValueRef Val);
521 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal);
522 int LLVMHasMetadata(LLVMValueRef Val);
523 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID);
524 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node);
526 /* Conversion functions. Return the input value if it is an instance of the
527 specified class, otherwise NULL. See llvm::dyn_cast_or_null<>. */
528 #define LLVM_DECLARE_VALUE_CAST(name) \
529 LLVMValueRef LLVMIsA##name(LLVMValueRef Val);
530 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST)
532 /* Operations on Uses */
533 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val);
534 LLVMUseRef LLVMGetNextUse(LLVMUseRef U);
535 LLVMValueRef LLVMGetUser(LLVMUseRef U);
536 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U);
538 /* Operations on Users */
539 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index);
540 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val);
541 int LLVMGetNumOperands(LLVMValueRef Val);
543 /* Operations on constants of any type */
544 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */
545 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); /* only for int/vector */
546 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty);
547 LLVMBool LLVMIsConstant(LLVMValueRef Val);
548 LLVMBool LLVMIsNull(LLVMValueRef Val);
549 LLVMBool LLVMIsUndef(LLVMValueRef Val);
550 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty);
552 /* Operations on metadata */
553 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str,
555 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen);
556 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals,
558 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count);
559 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len);
560 int LLVMGetMDNodeNumOperands(LLVMValueRef V);
561 LLVMValueRef *LLVMGetMDNodeOperand(LLVMValueRef V, unsigned i);
562 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name);
563 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest);
565 /* Operations on scalar constants */
566 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N,
567 LLVMBool SignExtend);
568 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy,
570 const uint64_t Words[]);
571 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text,
573 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text,
574 unsigned SLen, uint8_t Radix);
575 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N);
576 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text);
577 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text,
579 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal);
580 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal);
583 /* Operations on composite constants */
584 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str,
585 unsigned Length, LLVMBool DontNullTerminate);
586 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
587 LLVMValueRef *ConstantVals,
588 unsigned Count, LLVMBool Packed);
590 LLVMValueRef LLVMConstString(const char *Str, unsigned Length,
591 LLVMBool DontNullTerminate);
592 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
593 LLVMValueRef *ConstantVals, unsigned Length);
594 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count,
596 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy,
597 LLVMValueRef *ConstantVals,
599 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size);
601 /* Constant expressions */
602 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal);
603 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty);
604 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty);
605 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal);
606 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal);
607 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal);
608 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal);
609 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal);
610 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
611 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
612 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
613 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
614 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
615 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
616 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
617 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
618 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
619 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
620 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
621 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
622 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
623 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
624 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
625 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
626 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
627 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
628 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
629 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
630 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
631 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
632 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate,
633 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
634 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate,
635 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
636 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
637 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
638 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant);
639 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal,
640 LLVMValueRef *ConstantIndices, unsigned NumIndices);
641 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal,
642 LLVMValueRef *ConstantIndices,
643 unsigned NumIndices);
644 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
645 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
646 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
647 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
648 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
649 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
650 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
651 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
652 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
653 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
654 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
655 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
656 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal,
658 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal,
660 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal,
662 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal,
664 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType,
666 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType);
667 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition,
668 LLVMValueRef ConstantIfTrue,
669 LLVMValueRef ConstantIfFalse);
670 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant,
671 LLVMValueRef IndexConstant);
672 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant,
673 LLVMValueRef ElementValueConstant,
674 LLVMValueRef IndexConstant);
675 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant,
676 LLVMValueRef VectorBConstant,
677 LLVMValueRef MaskConstant);
678 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList,
680 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant,
681 LLVMValueRef ElementValueConstant,
682 unsigned *IdxList, unsigned NumIdx);
683 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty,
684 const char *AsmString, const char *Constraints,
685 LLVMBool HasSideEffects, LLVMBool IsAlignStack);
686 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB);
688 /* Operations on global variables, functions, and aliases (globals) */
689 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global);
690 LLVMBool LLVMIsDeclaration(LLVMValueRef Global);
691 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global);
692 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage);
693 const char *LLVMGetSection(LLVMValueRef Global);
694 void LLVMSetSection(LLVMValueRef Global, const char *Section);
695 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global);
696 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz);
697 unsigned LLVMGetAlignment(LLVMValueRef Global);
698 void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes);
700 /* Operations on global variables */
701 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name);
702 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty,
704 unsigned AddressSpace);
705 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name);
706 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M);
707 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M);
708 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar);
709 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar);
710 void LLVMDeleteGlobal(LLVMValueRef GlobalVar);
711 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar);
712 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal);
713 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar);
714 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal);
715 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar);
716 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant);
718 /* Operations on aliases */
719 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee,
722 /* Operations on functions */
723 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name,
724 LLVMTypeRef FunctionTy);
725 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name);
726 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M);
727 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M);
728 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn);
729 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn);
730 void LLVMDeleteFunction(LLVMValueRef Fn);
731 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn);
732 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn);
733 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC);
734 const char *LLVMGetGC(LLVMValueRef Fn);
735 void LLVMSetGC(LLVMValueRef Fn, const char *Name);
736 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
737 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn);
738 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA);
740 /* Operations on parameters */
741 unsigned LLVMCountParams(LLVMValueRef Fn);
742 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params);
743 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index);
744 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst);
745 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn);
746 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn);
747 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg);
748 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg);
749 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA);
750 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA);
751 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg);
752 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align);
754 /* Operations on basic blocks */
755 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB);
756 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val);
757 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val);
758 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB);
759 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB);
760 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn);
761 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks);
762 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn);
763 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn);
764 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB);
765 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB);
766 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn);
768 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C,
771 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C,
772 LLVMBasicBlockRef BB,
775 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name);
776 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB,
778 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB);
779 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB);
781 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
782 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos);
784 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB);
785 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB);
787 /* Operations on instructions */
788 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst);
789 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst);
790 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst);
791 void LLVMInstructionEraseFromParent(LLVMValueRef Inst);
792 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst);
794 /* Operations on call sites */
795 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC);
796 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr);
797 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute);
798 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index,
800 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index,
803 /* Operations on call instructions (only) */
804 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst);
805 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall);
807 /* Operations on switch instructions (only) */
808 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr);
810 /* Operations on phi nodes */
811 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues,
812 LLVMBasicBlockRef *IncomingBlocks, unsigned Count);
813 unsigned LLVMCountIncoming(LLVMValueRef PhiNode);
814 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index);
815 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index);
817 /*===-- Instruction builders ----------------------------------------------===*/
819 /* An instruction builder represents a point within a basic block, and is the
820 * exclusive means of building instructions using the C interface.
823 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
824 LLVMBuilderRef LLVMCreateBuilder(void);
825 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
827 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
828 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);
829 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder);
830 void LLVMClearInsertionPosition(LLVMBuilderRef Builder);
831 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr);
832 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr,
834 void LLVMDisposeBuilder(LLVMBuilderRef Builder);
837 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L);
838 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder);
839 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst);
842 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef);
843 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V);
844 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals,
846 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest);
847 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If,
848 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else);
849 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V,
850 LLVMBasicBlockRef Else, unsigned NumCases);
851 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr,
853 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn,
854 LLVMValueRef *Args, unsigned NumArgs,
855 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch,
857 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
858 LLVMValueRef PersFn, unsigned NumClauses,
860 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn);
861 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef);
863 /* Add a case to the switch instruction */
864 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal,
865 LLVMBasicBlockRef Dest);
867 /* Add a destination to the indirectbr instruction */
868 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest);
870 /* Add a catch or filter clause to the landingpad instruction */
871 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal);
873 /* Set the 'cleanup' flag in the landingpad instruction */
874 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val);
877 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
879 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
881 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
883 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
885 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
887 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
889 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
891 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
893 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
895 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
897 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
899 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
901 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
903 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
905 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
907 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
909 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
911 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
913 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
915 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
917 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
919 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
921 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
923 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
925 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS,
927 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op,
928 LLVMValueRef LHS, LLVMValueRef RHS,
930 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
931 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V,
933 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V,
935 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name);
936 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name);
939 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
940 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty,
941 LLVMValueRef Val, const char *Name);
942 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
943 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty,
944 LLVMValueRef Val, const char *Name);
945 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal);
946 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal,
948 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr);
949 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
950 LLVMValueRef *Indices, unsigned NumIndices,
952 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
953 LLVMValueRef *Indices, unsigned NumIndices,
955 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer,
956 unsigned Idx, const char *Name);
957 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str,
959 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str,
963 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val,
964 LLVMTypeRef DestTy, const char *Name);
965 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val,
966 LLVMTypeRef DestTy, const char *Name);
967 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val,
968 LLVMTypeRef DestTy, const char *Name);
969 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val,
970 LLVMTypeRef DestTy, const char *Name);
971 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val,
972 LLVMTypeRef DestTy, const char *Name);
973 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val,
974 LLVMTypeRef DestTy, const char *Name);
975 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val,
976 LLVMTypeRef DestTy, const char *Name);
977 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val,
978 LLVMTypeRef DestTy, const char *Name);
979 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val,
980 LLVMTypeRef DestTy, const char *Name);
981 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val,
982 LLVMTypeRef DestTy, const char *Name);
983 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val,
984 LLVMTypeRef DestTy, const char *Name);
985 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val,
986 LLVMTypeRef DestTy, const char *Name);
987 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
988 LLVMTypeRef DestTy, const char *Name);
989 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
990 LLVMTypeRef DestTy, const char *Name);
991 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val,
992 LLVMTypeRef DestTy, const char *Name);
993 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val,
994 LLVMTypeRef DestTy, const char *Name);
995 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val,
996 LLVMTypeRef DestTy, const char *Name);
997 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/
998 LLVMTypeRef DestTy, const char *Name);
999 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val,
1000 LLVMTypeRef DestTy, const char *Name);
1003 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op,
1004 LLVMValueRef LHS, LLVMValueRef RHS,
1006 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op,
1007 LLVMValueRef LHS, LLVMValueRef RHS,
1010 /* Miscellaneous instructions */
1011 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name);
1012 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn,
1013 LLVMValueRef *Args, unsigned NumArgs,
1015 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If,
1016 LLVMValueRef Then, LLVMValueRef Else,
1018 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty,
1020 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal,
1021 LLVMValueRef Index, const char *Name);
1022 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal,
1023 LLVMValueRef EltVal, LLVMValueRef Index,
1025 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1,
1026 LLVMValueRef V2, LLVMValueRef Mask,
1028 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal,
1029 unsigned Index, const char *Name);
1030 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal,
1031 LLVMValueRef EltVal, unsigned Index,
1034 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val,
1036 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val,
1038 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS,
1039 LLVMValueRef RHS, const char *Name);
1042 /*===-- Module providers --------------------------------------------------===*/
1044 /* Changes the type of M so it can be passed to FunctionPassManagers and the
1045 * JIT. They take ModuleProviders for historical reasons.
1047 LLVMModuleProviderRef
1048 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M);
1050 /* Destroys the module M.
1052 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M);
1055 /*===-- Memory buffers ----------------------------------------------------===*/
1057 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path,
1058 LLVMMemoryBufferRef *OutMemBuf,
1060 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf,
1062 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf);
1064 /*===-- Pass Registry -----------------------------------------------------===*/
1066 /** Return the global pass registry, for use with initialization functions.
1067 See llvm::PassRegistry::getPassRegistry. */
1068 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void);
1070 /*===-- Pass Managers -----------------------------------------------------===*/
1072 /** Constructs a new whole-module pass pipeline. This type of pipeline is
1073 suitable for link-time optimization and whole-module transformations.
1074 See llvm::PassManager::PassManager. */
1075 LLVMPassManagerRef LLVMCreatePassManager(void);
1077 /** Constructs a new function-by-function pass pipeline over the module
1078 provider. It does not take ownership of the module provider. This type of
1079 pipeline is suitable for code generation and JIT compilation tasks.
1080 See llvm::FunctionPassManager::FunctionPassManager. */
1081 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M);
1083 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */
1084 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP);
1086 /** Initializes, executes on the provided module, and finalizes all of the
1087 passes scheduled in the pass manager. Returns 1 if any of the passes
1088 modified the module, 0 otherwise. See llvm::PassManager::run(Module&). */
1089 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M);
1091 /** Initializes all of the function passes scheduled in the function pass
1092 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1093 See llvm::FunctionPassManager::doInitialization. */
1094 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM);
1096 /** Executes all of the function passes scheduled in the function pass manager
1097 on the provided function. Returns 1 if any of the passes modified the
1098 function, false otherwise.
1099 See llvm::FunctionPassManager::run(Function&). */
1100 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F);
1102 /** Finalizes all of the function passes scheduled in in the function pass
1103 manager. Returns 1 if any of the passes modified the module, 0 otherwise.
1104 See llvm::FunctionPassManager::doFinalization. */
1105 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM);
1107 /** Frees the memory of a pass pipeline. For function pipelines, does not free
1108 the module provider.
1109 See llvm::PassManagerBase::~PassManagerBase. */
1110 void LLVMDisposePassManager(LLVMPassManagerRef PM);
1118 class PassManagerBase;
1120 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1121 inline ty *unwrap(ref P) { \
1122 return reinterpret_cast<ty*>(P); \
1125 inline ref wrap(const ty *P) { \
1126 return reinterpret_cast<ref>(const_cast<ty*>(P)); \
1129 #define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref) \
1130 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1132 template<typename T> \
1133 inline T *unwrap(ref P) { \
1134 return cast<T>(unwrap(P)); \
1137 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref) \
1138 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref) \
1140 template<typename T> \
1141 inline T *unwrap(ref P) { \
1142 T *Q = (T*)unwrap(P); \
1143 assert(Q && "Invalid cast!"); \
1147 DEFINE_ISA_CONVERSION_FUNCTIONS (Type, LLVMTypeRef )
1148 DEFINE_ISA_CONVERSION_FUNCTIONS (Value, LLVMValueRef )
1149 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef )
1150 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(BasicBlock, LLVMBasicBlockRef )
1151 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef )
1152 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef )
1153 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef )
1154 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Use, LLVMUseRef )
1155 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBase, LLVMPassManagerRef )
1156 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef )
1157 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
1160 inline Module *unwrap(LLVMModuleProviderRef MP) {
1161 return reinterpret_cast<Module*>(MP);
1164 #undef DEFINE_STDCXX_CONVERSION_FUNCTIONS
1165 #undef DEFINE_ISA_CONVERSION_FUNCTIONS
1166 #undef DEFINE_SIMPLE_CONVERSION_FUNCTIONS
1168 /* Specialized opaque context conversions.
1170 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
1171 return reinterpret_cast<LLVMContext**>(Tys);
1174 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
1175 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
1178 /* Specialized opaque type conversions.
1180 inline Type **unwrap(LLVMTypeRef* Tys) {
1181 return reinterpret_cast<Type**>(Tys);
1184 inline LLVMTypeRef *wrap(Type **Tys) {
1185 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
1188 /* Specialized opaque value conversions.
1190 inline Value **unwrap(LLVMValueRef *Vals) {
1191 return reinterpret_cast<Value**>(Vals);
1194 template<typename T>
1195 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1197 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
1201 return reinterpret_cast<T**>(Vals);
1204 inline LLVMValueRef *wrap(const Value **Vals) {
1205 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1209 #endif /* !defined(__cplusplus) */
1211 #endif /* !defined(LLVM_C_CORE_H) */