Collaboration diagram for Execution Engine:

Modules
	LLJIT

	On-Request-Compilation

	ExecutionEngine-based ORC Utils

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	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)
	Create an MCJIT execution engine for a module, with the given options.

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)

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

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

void *	LLVMRecompileAndRelinkFunction (LLVMExecutionEngineRef EE, LLVMValueRef Fn)

LLVMTargetDataRef	LLVMGetExecutionEngineTargetData (LLVMExecutionEngineRef EE)

LLVMTargetMachineRef	LLVMGetExecutionEngineTargetMachine (LLVMExecutionEngineRef EE)

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

void *	LLVMGetPointerToGlobal (LLVMExecutionEngineRef EE, LLVMValueRef Global)

uint64_t	LLVMGetGlobalValueAddress (LLVMExecutionEngineRef EE, const char *Name)

uint64_t	LLVMGetFunctionAddress (LLVMExecutionEngineRef EE, const char *Name)

LLVMBool	LLVMExecutionEngineGetErrMsg (LLVMExecutionEngineRef EE, char **OutError)
	Returns true on error, false on success.

LLVMMCJITMemoryManagerRef	LLVMCreateSimpleMCJITMemoryManager (void *Opaque, LLVMMemoryManagerAllocateCodeSectionCallback AllocateCodeSection, LLVMMemoryManagerAllocateDataSectionCallback AllocateDataSection, LLVMMemoryManagerFinalizeMemoryCallback FinalizeMemory, LLVMMemoryManagerDestroyCallback Destroy)
	Create a simple custom MCJIT memory manager.

void	LLVMDisposeMCJITMemoryManager (LLVMMCJITMemoryManagerRef MM)

LLVMJITEventListenerRef	LLVMCreateGDBRegistrationListener (void)

LLVMJITEventListenerRef	LLVMCreateIntelJITEventListener (void)

LLVMJITEventListenerRef	LLVMCreateOProfileJITEventListener (void)

LLVMJITEventListenerRef	LLVMCreatePerfJITEventListener (void)

Detailed Description

Typedef Documentation

◆ LLVMExecutionEngineRef

typedef struct LLVMOpaqueExecutionEngine* LLVMExecutionEngineRef

Definition at line 40 of file ExecutionEngine.h.

◆ LLVMGenericValueRef

typedef struct LLVMOpaqueGenericValue* LLVMGenericValueRef

Definition at line 39 of file ExecutionEngine.h.

◆ LLVMMCJITMemoryManagerRef

typedef struct LLVMOpaqueMCJITMemoryManager* LLVMMCJITMemoryManagerRef

Definition at line 41 of file ExecutionEngine.h.

◆ LLVMMemoryManagerAllocateCodeSectionCallback

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

Definition at line 159 of file ExecutionEngine.h.

◆ LLVMMemoryManagerAllocateDataSectionCallback

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

Definition at line 162 of file ExecutionEngine.h.

◆ LLVMMemoryManagerDestroyCallback

typedef void(* LLVMMemoryManagerDestroyCallback) (void *Opaque)

Definition at line 167 of file ExecutionEngine.h.

◆ LLVMMemoryManagerFinalizeMemoryCallback

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

Definition at line 165 of file ExecutionEngine.h.

Function Documentation

◆ LLVMAddGlobalMapping()

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

Definition at line 292 of file ExecutionEngineBindings.cpp.

References Addr, llvm::Global, and llvm::unwrap().

◆ LLVMAddModule()

void LLVMAddModule	(	LLVMExecutionEngineRef	EE,
		LLVMModuleRef	M
	)

Definition at line 257 of file ExecutionEngineBindings.cpp.

References llvm::unwrap().

◆ LLVMCreateExecutionEngineForModule()

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

Definition at line 104 of file ExecutionEngineBindings.cpp.

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

◆ LLVMCreateGDBRegistrationListener()

LLVMJITEventListenerRef LLVMCreateGDBRegistrationListener ( void )

Definition at line 249 of file GDBRegistrationListener.cpp.

References llvm::JITEventListener::createGDBRegistrationListener(), and llvm::wrap().

◆ LLVMCreateGenericValueOfFloat()

LLVMGenericValueRef LLVMCreateGenericValueOfFloat	(	LLVMTypeRef	Ty,
		double	N
	)

Definition at line 55 of file ExecutionEngineBindings.cpp.

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

◆ LLVMCreateGenericValueOfInt()

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

Definition at line 41 of file ExecutionEngineBindings.cpp.

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

◆ LLVMCreateGenericValueOfPointer()

LLVMGenericValueRef LLVMCreateGenericValueOfPointer ( void * P )

Definition at line 49 of file ExecutionEngineBindings.cpp.

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

◆ LLVMCreateIntelJITEventListener()

LLVMJITEventListenerRef LLVMCreateIntelJITEventListener ( void )

Definition at line 430 of file ExecutionEngineBindings.cpp.

References llvm::JITEventListener::createIntelJITEventListener(), and llvm::wrap().

◆ LLVMCreateInterpreterForModule()

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

Definition at line 119 of file ExecutionEngineBindings.cpp.

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

◆ LLVMCreateJITCompilerForModule()

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

Definition at line 134 of file ExecutionEngineBindings.cpp.

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

◆ LLVMCreateMCJITCompilerForModule()

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 161 of file ExecutionEngineBindings.cpp.

References llvm::EngineBuilder::create(), llvm::TargetOptions::EnableFastISel, F, llvm::EngineKind::JIT, LLVMInitializeMCJITCompilerOptions(), Mod, llvm::EngineBuilder::setCodeModel(), llvm::EngineBuilder::setEngineKind(), llvm::EngineBuilder::setErrorStr(), llvm::EngineBuilder::setMCJITMemoryManager(), llvm::EngineBuilder::setOptLevel(), llvm::EngineBuilder::setTargetOptions(), llvm::unwrap(), and wrap().

◆ LLVMCreateOProfileJITEventListener()

LLVMJITEventListenerRef LLVMCreateOProfileJITEventListener ( void )

Definition at line 437 of file ExecutionEngineBindings.cpp.

References llvm::JITEventListener::createOProfileJITEventListener(), and llvm::wrap().

◆ LLVMCreatePerfJITEventListener()

LLVMJITEventListenerRef LLVMCreatePerfJITEventListener ( void )

Definition at line 444 of file ExecutionEngineBindings.cpp.

References llvm::JITEventListener::createPerfJITEventListener(), and llvm::wrap().

◆ LLVMCreateSimpleMCJITMemoryManager()

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 403 of file ExecutionEngineBindings.cpp.

References functions, and wrap().