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