Execution Engine

Collaboration diagram for Execution Engine:

Classes
struct	LLVMMCJITCompilerOptions

Typedefs
typedef struct LLVMOpaqueGenericValue *	LLVMGenericValueRef
typedef struct LLVMOpaqueExecutionEngine *	LLVMExecutionEngineRef
typedef struct LLVMOpaqueMCJITMemoryManager *	LLVMMCJITMemoryManagerRef
typedef uint8_t *(*	LLVMMemoryManagerAllocateCodeSectionCallback )(void *Opaque, uintptr_t Size, unsigned Alignment, unsigned SectionID, const char *SectionName)
typedef uint8_t *(*	LLVMMemoryManagerAllocateDataSectionCallback )(void *Opaque, uintptr_t Size, unsigned Alignment, unsigned SectionID, const char *SectionName, LLVMBool IsReadOnly)
typedef LLVMBool(*	LLVMMemoryManagerFinalizeMemoryCallback )(void *Opaque, char **ErrMsg)
typedef void(*	LLVMMemoryManagerDestroyCallback )(void *Opaque)

Functions
void	LLVMLinkInJIT (void)
void	LLVMLinkInMCJIT (void)
void	LLVMLinkInInterpreter (void)
LLVMGenericValueRef	LLVMCreateGenericValueOfInt (LLVMTypeRef Ty, unsigned long long N, LLVMBool IsSigned)
LLVMGenericValueRef	LLVMCreateGenericValueOfPointer (void *P)
LLVMGenericValueRef	LLVMCreateGenericValueOfFloat (LLVMTypeRef Ty, double N)
unsigned	LLVMGenericValueIntWidth (LLVMGenericValueRef GenValRef)
unsigned long long	LLVMGenericValueToInt (LLVMGenericValueRef GenVal, LLVMBool IsSigned)
void *	LLVMGenericValueToPointer (LLVMGenericValueRef GenVal)
double	LLVMGenericValueToFloat (LLVMTypeRef TyRef, LLVMGenericValueRef GenVal)
void	LLVMDisposeGenericValue (LLVMGenericValueRef GenVal)
LLVMBool	LLVMCreateExecutionEngineForModule (LLVMExecutionEngineRef *OutEE, LLVMModuleRef M, char **OutError)
LLVMBool	LLVMCreateInterpreterForModule (LLVMExecutionEngineRef *OutInterp, LLVMModuleRef M, char **OutError)
LLVMBool	LLVMCreateJITCompilerForModule (LLVMExecutionEngineRef *OutJIT, LLVMModuleRef M, unsigned OptLevel, char **OutError)
void	LLVMInitializeMCJITCompilerOptions (struct LLVMMCJITCompilerOptions *Options, size_t SizeOfOptions)
LLVMBool	LLVMCreateMCJITCompilerForModule (LLVMExecutionEngineRef *OutJIT, LLVMModuleRef M, struct LLVMMCJITCompilerOptions *Options, size_t SizeOfOptions, char **OutError)
LLVMBool	LLVMCreateExecutionEngine (LLVMExecutionEngineRef *OutEE, LLVMModuleProviderRef MP, char **OutError)
LLVMBool	LLVMCreateInterpreter (LLVMExecutionEngineRef *OutInterp, LLVMModuleProviderRef MP, char **OutError)
LLVMBool	LLVMCreateJITCompiler (LLVMExecutionEngineRef *OutJIT, LLVMModuleProviderRef MP, unsigned OptLevel, char **OutError)
void	LLVMDisposeExecutionEngine (LLVMExecutionEngineRef EE)
void	LLVMRunStaticConstructors (LLVMExecutionEngineRef EE)
void	LLVMRunStaticDestructors (LLVMExecutionEngineRef EE)
int	LLVMRunFunctionAsMain (LLVMExecutionEngineRef EE, LLVMValueRef F, unsigned ArgC, const char *const *ArgV, const char *const *EnvP)
LLVMGenericValueRef	LLVMRunFunction (LLVMExecutionEngineRef EE, LLVMValueRef F, unsigned NumArgs, LLVMGenericValueRef *Args)
void	LLVMFreeMachineCodeForFunction (LLVMExecutionEngineRef EE, LLVMValueRef F)
void	LLVMAddModule (LLVMExecutionEngineRef EE, LLVMModuleRef M)
void	LLVMAddModuleProvider (LLVMExecutionEngineRef EE, LLVMModuleProviderRef MP)
LLVMBool	LLVMRemoveModule (LLVMExecutionEngineRef EE, LLVMModuleRef M, LLVMModuleRef *OutMod, char **OutError)
LLVMBool	LLVMRemoveModuleProvider (LLVMExecutionEngineRef EE, LLVMModuleProviderRef MP, LLVMModuleRef *OutMod, char **OutError)
LLVMBool	LLVMFindFunction (LLVMExecutionEngineRef EE, const char *Name, LLVMValueRef *OutFn)
void *	LLVMRecompileAndRelinkFunction (LLVMExecutionEngineRef EE, LLVMValueRef Fn)
LLVMTargetDataRef	LLVMGetExecutionEngineTargetData (LLVMExecutionEngineRef EE)
void	LLVMAddGlobalMapping (LLVMExecutionEngineRef EE, LLVMValueRef Global, void *Addr)
void *	LLVMGetPointerToGlobal (LLVMExecutionEngineRef EE, LLVMValueRef Global)
LLVMMCJITMemoryManagerRef	LLVMCreateSimpleMCJITMemoryManager (void *Opaque, LLVMMemoryManagerAllocateCodeSectionCallback AllocateCodeSection, LLVMMemoryManagerAllocateDataSectionCallback AllocateDataSection, LLVMMemoryManagerFinalizeMemoryCallback FinalizeMemory, LLVMMemoryManagerDestroyCallback Destroy)
void	LLVMDisposeMCJITMemoryManager (LLVMMCJITMemoryManagerRef MM)

Detailed Description

Typedef Documentation

typedef struct LLVMOpaqueExecutionEngine* LLVMExecutionEngineRef

Definition at line 42 of file c/ExecutionEngine.h.

typedef struct LLVMOpaqueGenericValue* LLVMGenericValueRef

Definition at line 41 of file c/ExecutionEngine.h.

typedef struct LLVMOpaqueMCJITMemoryManager* LLVMMCJITMemoryManagerRef

Definition at line 43 of file c/ExecutionEngine.h.

typedef uint8_t*(* LLVMMemoryManagerAllocateCodeSectionCallback)(void *Opaque, uintptr_t Size, unsigned Alignment, unsigned SectionID, const char *SectionName)

Definition at line 174 of file c/ExecutionEngine.h.

typedef uint8_t*(* LLVMMemoryManagerAllocateDataSectionCallback)(void *Opaque, uintptr_t Size, unsigned Alignment, unsigned SectionID, const char *SectionName, LLVMBool IsReadOnly)

Definition at line 177 of file c/ExecutionEngine.h.

typedef void(* LLVMMemoryManagerDestroyCallback)(void *Opaque)

Definition at line 182 of file c/ExecutionEngine.h.

typedef LLVMBool(* LLVMMemoryManagerFinalizeMemoryCallback)(void *Opaque, char **ErrMsg)

Definition at line 180 of file c/ExecutionEngine.h.

Function Documentation

void LLVMAddGlobalMapping	(	LLVMExecutionEngineRef	EE,
		LLVMValueRef	Global,
		void *	Addr
	)

Definition at line 326 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().

void LLVMAddModule	(	LLVMExecutionEngineRef	EE,
		LLVMModuleRef	M
	)

Definition at line 283 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().

Referenced by LLVMAddModuleProvider().

void LLVMAddModuleProvider	(	LLVMExecutionEngineRef	EE,
		LLVMModuleProviderRef	MP
	)

Deprecated: Use LLVMAddModule instead.

Definition at line 287 of file ExecutionEngineBindings.cpp.

References LLVMAddModule().

LLVMBool LLVMCreateExecutionEngine	(	LLVMExecutionEngineRef *	OutEE,
		LLVMModuleProviderRef	MP,
		char **	OutError
	)

Deprecated: Use LLVMCreateExecutionEngineForModule instead.

Definition at line 211 of file ExecutionEngineBindings.cpp.

References LLVMCreateExecutionEngineForModule().

LLVMBool LLVMCreateExecutionEngineForModule	(	LLVMExecutionEngineRef *	OutEE,
		LLVMModuleRef	M,
		char **	OutError
	)

Definition at line 111 of file ExecutionEngineBindings.cpp.

References llvm::EngineBuilder::create(), llvm::EngineKind::Either, llvm::lltok::Error, llvm::EngineBuilder::setEngineKind(), llvm::EngineBuilder::setErrorStr(), llvm::LibFunc::strdup, llvm::unwrap(), and llvm::wrap().

Referenced by LLVMCreateExecutionEngine().

LLVMGenericValueRef LLVMCreateGenericValueOfFloat	(	LLVMTypeRef	Ty,
		double	N
	)

Definition at line 62 of file ExecutionEngineBindings.cpp.

References llvm::Type::DoubleTyID, llvm::GenericValue::DoubleVal, llvm::Type::FloatTyID, llvm::GenericValue::FloatVal, getTypeID(), llvm_unreachable, N, llvm::unwrap(), and llvm::wrap().

LLVMGenericValueRef LLVMCreateGenericValueOfInt	(	LLVMTypeRef	Ty,
		unsigned long long	N,
		LLVMBool	IsSigned
	)

Definition at line 48 of file ExecutionEngineBindings.cpp.

References getBitWidth(), llvm::GenericValue::IntVal, and llvm::wrap().

LLVMGenericValueRef LLVMCreateGenericValueOfPointer

(

void *

P

)

Definition at line 56 of file ExecutionEngineBindings.cpp.

References P, llvm::GenericValue::PointerVal, and llvm::wrap().

LLVMBool LLVMCreateInterpreter	(	LLVMExecutionEngineRef *	OutInterp,
		LLVMModuleProviderRef	MP,
		char **	OutError
	)

Deprecated: Use LLVMCreateInterpreterForModule instead.

Definition at line 220 of file ExecutionEngineBindings.cpp.

References LLVMCreateInterpreterForModule().

LLVMBool LLVMCreateInterpreterForModule	(	LLVMExecutionEngineRef *	OutInterp,
		LLVMModuleRef	M,
		char **	OutError
	)

Definition at line 126 of file ExecutionEngineBindings.cpp.

References llvm::EngineBuilder::create(), llvm::lltok::Error, llvm::EngineKind::Interpreter, llvm::EngineBuilder::setEngineKind(), llvm::EngineBuilder::setErrorStr(), llvm::LibFunc::strdup, llvm::unwrap(), and llvm::wrap().

Referenced by LLVMCreateInterpreter().

LLVMBool LLVMCreateJITCompiler	(	LLVMExecutionEngineRef *	OutJIT,
		LLVMModuleProviderRef	MP,
		unsigned	OptLevel,
		char **	OutError
	)

Deprecated: Use LLVMCreateJITCompilerForModule instead.

Definition at line 229 of file ExecutionEngineBindings.cpp.

References LLVMCreateJITCompilerForModule().

LLVMBool LLVMCreateJITCompilerForModule	(	LLVMExecutionEngineRef *	OutJIT,
		LLVMModuleRef	M,
		unsigned	OptLevel,
		char **	OutError
	)

Definition at line 141 of file ExecutionEngineBindings.cpp.

References llvm::EngineBuilder::create(), llvm::lltok::Error, llvm::EngineKind::JIT, llvm::EngineBuilder::setEngineKind(), llvm::EngineBuilder::setErrorStr(), llvm::EngineBuilder::setOptLevel(), llvm::LibFunc::strdup, llvm::unwrap(), and llvm::wrap().

Referenced by LLVMCreateJITCompiler().

LLVMBool LLVMCreateMCJITCompilerForModule	(	LLVMExecutionEngineRef *	OutJIT,
		LLVMModuleRef	M,
		struct LLVMMCJITCompilerOptions *	Options,
		size_t	SizeOfOptions,
		char **	OutError
	)

Create an MCJIT execution engine for a module, with the given options. It is the responsibility of the caller to ensure that all fields in Options up to the given SizeOfOptions are initialized. It is correct to pass a smaller value of SizeOfOptions that omits some fields. The canonical way of using this is:

LLVMMCJITCompilerOptions options; LLVMInitializeMCJITCompilerOptions(&options, sizeof(options)); ... fill in those options you care about LLVMCreateMCJITCompilerForModule(&jit, mod, &options, sizeof(options), &error);

Note that this is also correct, though possibly suboptimal:

LLVMCreateMCJITCompilerForModule(&jit, mod, 0, 0, &error);

Definition at line 168 of file ExecutionEngineBindings.cpp.

References LLVMMCJITCompilerOptions::CodeModel, llvm::EngineBuilder::create(), LLVMMCJITCompilerOptions::EnableFastISel, llvm::TargetOptions::EnableFastISel, llvm::lltok::Error, llvm::EngineKind::JIT, LLVMInitializeMCJITCompilerOptions(), LLVMMCJITCompilerOptions::MCJMM, llvm::Intrinsic::memcpy, LLVMMCJITCompilerOptions::NoFramePointerElim, llvm::TargetOptions::NoFramePointerElim, LLVMMCJITCompilerOptions::OptLevel, llvm::EngineBuilder::setCodeModel(), llvm::EngineBuilder::setEngineKind(), llvm::EngineBuilder::setErrorStr(), llvm::EngineBuilder::setMCJITMemoryManager(), llvm::EngineBuilder::setOptLevel(), llvm::EngineBuilder::setTargetOptions(), llvm::EngineBuilder::setUseMCJIT(), llvm::LibFunc::strdup, llvm::unwrap(), and llvm::wrap().

LLVMMCJITMemoryManagerRef LLVMCreateSimpleMCJITMemoryManager	(	void *	Opaque,
		LLVMMemoryManagerAllocateCodeSectionCallback	AllocateCodeSection,
		LLVMMemoryManagerAllocateDataSectionCallback	AllocateDataSection,
		LLVMMemoryManagerFinalizeMemoryCallback	FinalizeMemory,
		LLVMMemoryManagerDestroyCallback	Destroy
	)

Create a simple custom MCJIT memory manager. This memory manager can intercept allocations in a module-oblivious way. This will return NULL if any of the passed functions are NULL.

Parameters

Opaque	An opaque client object to pass back to the callbacks.
AllocateCodeSection	Allocate a block of memory for executable code.
AllocateDataSection	Allocate a block of memory for data.
FinalizeMemory	Set page permissions and flush cache. Return 0 on success, 1 on error.

Definition at line 417 of file ExecutionEngineBindings.cpp.

References functions, and wrap().

void LLVMDisposeExecutionEngine

(

LLVMExecutionEngineRef

EE

)

Definition at line 240 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().

void LLVMDisposeGenericValue

(

LLVMGenericValueRef

GenVal

)

Definition at line 105 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().

void LLVMDisposeMCJITMemoryManager

(

LLVMMCJITMemoryManagerRef

MM

)

Definition at line 436 of file ExecutionEngineBindings.cpp.

References unwrap().

LLVMBool LLVMFindFunction	(	LLVMExecutionEngineRef	EE,
		const char *	Name,
		LLVMValueRef *	OutFn
	)

Definition at line 308 of file ExecutionEngineBindings.cpp.

References F(), llvm::unwrap(), and llvm::wrap().

void LLVMFreeMachineCodeForFunction	(	LLVMExecutionEngineRef	EE,
		LLVMValueRef	F
	)

Definition at line 279 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().

unsigned LLVMGenericValueIntWidth

(

LLVMGenericValueRef

GenValRef

)

Definition at line 77 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().

double LLVMGenericValueToFloat	(	LLVMTypeRef	TyRef,
		LLVMGenericValueRef	GenVal
	)

Definition at line 94 of file ExecutionEngineBindings.cpp.

References llvm::Type::DoubleTyID, llvm::Type::FloatTyID, getTypeID(), llvm_unreachable, and llvm::unwrap().

unsigned long long LLVMGenericValueToInt	(	LLVMGenericValueRef	GenVal,
		LLVMBool	IsSigned
	)

Definition at line 81 of file ExecutionEngineBindings.cpp.

References llvm::APInt::getSExtValue(), llvm::APInt::getZExtValue(), llvm::GenericValue::IntVal, and llvm::unwrap().

void* LLVMGenericValueToPointer

(

LLVMGenericValueRef

GenVal

)

Definition at line 90 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().

LLVMTargetDataRef LLVMGetExecutionEngineTargetData

(

LLVMExecutionEngineRef

EE

)

Definition at line 322 of file ExecutionEngineBindings.cpp.

References llvm::unwrap(), and llvm::wrap().

void* LLVMGetPointerToGlobal	(	LLVMExecutionEngineRef	EE,
		LLVMValueRef	Global
	)

Definition at line 331 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().

void LLVMInitializeMCJITCompilerOptions	(	struct LLVMMCJITCompilerOptions *	Options,
		size_t	SizeOfOptions
	)

Definition at line 158 of file ExecutionEngineBindings.cpp.

References LLVMMCJITCompilerOptions::CodeModel, LLVMCodeModelJITDefault, llvm::Intrinsic::memcpy, and llvm::Intrinsic::memset.

Referenced by LLVMCreateMCJITCompilerForModule().

void LLVMLinkInInterpreter

(

void

)

Definition at line 31 of file Interpreter.cpp.

void LLVMLinkInJIT

(

void

)

Definition at line 67 of file JIT.cpp.

void LLVMLinkInMCJIT

(

void

)

Definition at line 39 of file MCJIT.cpp.

void* LLVMRecompileAndRelinkFunction	(	LLVMExecutionEngineRef	EE,
		LLVMValueRef	Fn
	)

Definition at line 317 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().

LLVMBool LLVMRemoveModule	(	LLVMExecutionEngineRef	EE,
		LLVMModuleRef	M,
		LLVMModuleRef *	OutMod,
		char **	OutError
	)

Definition at line 292 of file ExecutionEngineBindings.cpp.

References llvm::unwrap(), and llvm::wrap().

Referenced by LLVMRemoveModuleProvider().

LLVMBool LLVMRemoveModuleProvider	(	LLVMExecutionEngineRef	EE,
		LLVMModuleProviderRef	MP,
		LLVMModuleRef *	OutMod,
		char **	OutError
	)

Deprecated: Use LLVMRemoveModule instead.

Definition at line 300 of file ExecutionEngineBindings.cpp.

References LLVMRemoveModule().

LLVMGenericValueRef LLVMRunFunction	(	LLVMExecutionEngineRef	EE,
		LLVMValueRef	F,
		unsigned	NumArgs,
		LLVMGenericValueRef *	Args
	)

Definition at line 264 of file ExecutionEngineBindings.cpp.

References I, llvm::unwrap(), and llvm::wrap().

int LLVMRunFunctionAsMain	(	LLVMExecutionEngineRef	EE,
		LLVMValueRef	F,
		unsigned	ArgC,
		const char *const *	ArgV,
		const char *const *	EnvP
	)

Definition at line 252 of file ExecutionEngineBindings.cpp.

References I, and llvm::unwrap().

void LLVMRunStaticConstructors

(

LLVMExecutionEngineRef

EE

)

Definition at line 244 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().

void LLVMRunStaticDestructors

(

LLVMExecutionEngineRef

EE

)

Definition at line 248 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().