ExecutorProcessControl supports interaction with a JIT target process. More...

#include "llvm/ExecutionEngine/Orc/ExecutorProcessControl.h"

Inheritance diagram for llvm::orc::ExecutorProcessControl:

[legend]

Classes
class	IncomingWFRHandler
	A handler or incoming WrapperFunctionResults – either return values from callWrapper* calls, or incoming JIT-dispatch requests. More...

struct	JITDispatchInfo
	Contains the address of the dispatch function and context that the ORC runtime can use to call functions in the JIT. More...

struct	LookupRequest
	A pair of a dylib and a set of symbols to be looked up. More...

class	MemoryAccess
	APIs for manipulating memory in the target process. More...

class	RunAsTask
	Constructs an IncomingWFRHandler from a function object by creating a new function object that dispatches the original using a TaskDispatcher, wrapping the original as a GenericNamedTask. More...

class	RunInPlace
	Constructs an IncomingWFRHandler from a function object that is callable as void(shared::WrapperFunctionResult). More...

Public Types
using	SymbolLookupCompleteFn = unique_function< void(Expected< std::vector< tpctypes::LookupResult > >)>

Public Member Functions
	ExecutorProcessControl (std::shared_ptr< SymbolStringPool > SSP, std::unique_ptr< TaskDispatcher > D)

virtual	~ExecutorProcessControl ()

ExecutionSession &	getExecutionSession ()
	Return the ExecutionSession associated with this instance.

SymbolStringPtr	intern (StringRef SymName)
	Intern a symbol name in the SymbolStringPool.

std::shared_ptr< SymbolStringPool >	getSymbolStringPool () const
	Return a shared pointer to the SymbolStringPool for this instance.

TaskDispatcher &	getDispatcher ()

const Triple &	getTargetTriple () const
	Return the Triple for the target process.

unsigned	getPageSize () const
	Get the page size for the target process.

const JITDispatchInfo &	getJITDispatchInfo () const
	Get the JIT dispatch function and context address for the executor.

MemoryAccess &	getMemoryAccess () const
	Return a MemoryAccess object for the target process.

jitlink::JITLinkMemoryManager &	getMemMgr () const
	Return a JITLinkMemoryManager for the target process.

const StringMap< std::vector< char > > &	getBootstrapMap () const
	Returns the bootstrap map.

template<typename T , typename SPSTagT >
Error	getBootstrapMapValue (StringRef Key, std::optional< T > &Val) const
	Look up and SPS-deserialize a bootstrap map value.

const StringMap< ExecutorAddr > &	getBootstrapSymbolsMap () const
	Returns the bootstrap symbol map.

Error	getBootstrapSymbols (ArrayRef< std::pair< ExecutorAddr &, StringRef > > Pairs) const
	For each (ExecutorAddr&, StringRef) pair, looks up the string in the bootstrap symbols map and writes its address to the ExecutorAddr if found.

virtual Expected< tpctypes::DylibHandle >	loadDylib (const char *DylibPath)=0
	Load the dynamic library at the given path and return a handle to it.

Expected< std::vector< tpctypes::LookupResult > >	lookupSymbols (ArrayRef< LookupRequest > Request)
	Search for symbols in the target process.

virtual void	lookupSymbolsAsync (ArrayRef< LookupRequest > Request, SymbolLookupCompleteFn F)=0
	Search for symbols in the target process.

virtual Expected< int32_t >	runAsMain (ExecutorAddr MainFnAddr, ArrayRef< std::string > Args)=0
	Run function with a main-like signature.

virtual Expected< int32_t >	runAsVoidFunction (ExecutorAddr VoidFnAddr)=0
	Run function with a int (*)(void) signature.

virtual Expected< int32_t >	runAsIntFunction (ExecutorAddr IntFnAddr, int Arg)=0
	Run function with a int (*)(int) signature.

virtual void	callWrapperAsync (ExecutorAddr WrapperFnAddr, IncomingWFRHandler OnComplete, ArrayRef< char > ArgBuffer)=0
	Run a wrapper function in the executor.

template<typename RunPolicyT , typename FnT >
void	callWrapperAsync (RunPolicyT &&Runner, ExecutorAddr WrapperFnAddr, FnT &&OnComplete, ArrayRef< char > ArgBuffer)
	Run a wrapper function in the executor using the given Runner to dispatch OnComplete when the result is ready.

template<typename FnT >
void	callWrapperAsync (ExecutorAddr WrapperFnAddr, FnT &&OnComplete, ArrayRef< char > ArgBuffer)
	Run a wrapper function in the executor.

shared::WrapperFunctionResult	callWrapper (ExecutorAddr WrapperFnAddr, ArrayRef< char > ArgBuffer)
	Run a wrapper function in the executor.

template<typename SPSSignature , typename RunPolicyT , typename SendResultT , typename... ArgTs>
void	callSPSWrapperAsync (RunPolicyT &&Runner, ExecutorAddr WrapperFnAddr, SendResultT &&SendResult, const ArgTs &...Args)
	Run a wrapper function using SPS to serialize the arguments and deserialize the results.

template<typename SPSSignature , typename SendResultT , typename... ArgTs>
void	callSPSWrapperAsync (ExecutorAddr WrapperFnAddr, SendResultT &&SendResult, const ArgTs &...Args)
	Run a wrapper function using SPS to serialize the arguments and deserialize the results.

template<typename SPSSignature , typename... WrapperCallArgTs>
Error	callSPSWrapper (ExecutorAddr WrapperFnAddr, WrapperCallArgTs &&...WrapperCallArgs)
	Run a wrapper function using SPS to serialize the arguments and deserialize the results.

virtual Error	disconnect ()=0
	Disconnect from the target process.

Protected Attributes
std::shared_ptr< SymbolStringPool >	SSP

std::unique_ptr< TaskDispatcher >	D

ExecutionSession *	ES = nullptr

Triple	TargetTriple

unsigned	PageSize = 0

JITDispatchInfo	JDI

MemoryAccess *	MemAccess = nullptr

jitlink::JITLinkMemoryManager *	MemMgr = nullptr

StringMap< std::vector< char > >	BootstrapMap

StringMap< ExecutorAddr >	BootstrapSymbols

Friends
class	ExecutionSession

Detailed Description

ExecutorProcessControl supports interaction with a JIT target process.

Definition at line 38 of file ExecutorProcessControl.h.

Member Typedef Documentation

◆ SymbolLookupCompleteFn

using llvm::orc::ExecutorProcessControl::SymbolLookupCompleteFn = unique_function<void(Expected<std::vector<tpctypes::LookupResult> >)>

Definition at line 302 of file ExecutorProcessControl.h.

Constructor & Destructor Documentation

◆ ExecutorProcessControl()

llvm::orc::ExecutorProcessControl::ExecutorProcessControl	(	std::shared_ptr< SymbolStringPool >	SSP,
		std::unique_ptr< TaskDispatcher >	D
	)

inline

Definition at line 190 of file ExecutorProcessControl.h.

◆ ~ExecutorProcessControl()

llvm::orc::ExecutorProcessControl::~ExecutorProcessControl ( )

virtualdefault

Member Function Documentation

◆ callSPSWrapper()

template<typename SPSSignature , typename... WrapperCallArgTs>

Error llvm::orc::ExecutorProcessControl::callSPSWrapper	(	ExecutorAddr	WrapperFnAddr,
		WrapperCallArgTs &&...	WrapperCallArgs
	)

inline

Run a wrapper function using SPS to serialize the arguments and deserialize the results.

If SPSSignature is a non-void function signature then the second argument (the first in the Args list) should be a reference to a return value.

Definition at line 407 of file ExecutorProcessControl.h.

References callWrapper().

Referenced by llvm::orc::EPCGenericRTDyldMemoryManager::finalizeMemory(), llvm::orc::VTuneSupportPlugin::notifyRemovingResources(), llvm::orc::PerfSupportPlugin::PerfSupportPlugin(), llvm::orc::EPCGenericRTDyldMemoryManager::reserveAllocationSpace(), llvm::orc::EPCGenericRTDyldMemoryManager::~EPCGenericRTDyldMemoryManager(), and llvm::orc::PerfSupportPlugin::~PerfSupportPlugin().

◆ callSPSWrapperAsync() [1/2]

template<typename SPSSignature , typename SendResultT , typename... ArgTs>

void llvm::orc::ExecutorProcessControl::callSPSWrapperAsync	(	ExecutorAddr	WrapperFnAddr,
		SendResultT &&	SendResult,
		const ArgTs &...	Args
	)

inline

Run a wrapper function using SPS to serialize the arguments and deserialize the results.

Definition at line 394 of file ExecutorProcessControl.h.

References D.

◆ callSPSWrapperAsync() [2/2]

template<typename SPSSignature , typename RunPolicyT , typename SendResultT , typename... ArgTs>

void llvm::orc::ExecutorProcessControl::callSPSWrapperAsync	(	RunPolicyT &&	Runner,
		ExecutorAddr	WrapperFnAddr,
		SendResultT &&	SendResult,
		const ArgTs &...	Args
	)

inline

Run a wrapper function using SPS to serialize the arguments and deserialize the results.

Definition at line 379 of file ExecutorProcessControl.h.

References callWrapperAsync().

◆ callWrapper()

shared::WrapperFunctionResult llvm::orc::ExecutorProcessControl::callWrapper	(	ExecutorAddr	WrapperFnAddr,
		ArrayRef< char >	ArgBuffer
	)

inline

Run a wrapper function in the executor.

The wrapper function should be callable as:

CWrapperFunctionResult fn(uint8_t *Data, uint64_t Size);

Size

uint64_t Size

Definition: ELFObjHandler.cpp:81

uint64_t

llvm::Data

@ Data

Definition: SIMachineScheduler.h:55

{.cpp}

Definition at line 363 of file ExecutorProcessControl.h.

References callWrapperAsync().

Referenced by callSPSWrapper().

◆ callWrapperAsync() [1/3]

template<typename FnT >

void llvm::orc::ExecutorProcessControl::callWrapperAsync	(	ExecutorAddr	WrapperFnAddr,
		FnT &&	OnComplete,
		ArrayRef< char >	ArgBuffer
	)

inline

Run a wrapper function in the executor.

OnComplete will be dispatched as a GenericNamedTask using this instance's TaskDispatch object.

Definition at line 351 of file ExecutorProcessControl.h.

References callWrapperAsync(), and D.

◆ callWrapperAsync() [2/3]

virtual void llvm::orc::ExecutorProcessControl::callWrapperAsync	(	ExecutorAddr	WrapperFnAddr,
		IncomingWFRHandler	OnComplete,
		ArrayRef< char >	ArgBuffer
	)

pure virtual

Run a wrapper function in the executor.

The given WFRHandler will be called on the result when it is returned.

The wrapper function should be callable as:

CWrapperFunctionResult fn(uint8_t *Data, uint64_t Size);

{.cpp}

Implemented in llvm::orc::UnsupportedExecutorProcessControl, llvm::orc::SelfExecutorProcessControl, and llvm::orc::SimpleRemoteEPC.

Referenced by callSPSWrapperAsync(), callWrapper(), and callWrapperAsync().

◆ callWrapperAsync() [3/3]

template<typename RunPolicyT , typename FnT >

void llvm::orc::ExecutorProcessControl::callWrapperAsync	(	RunPolicyT &&	Runner,
		ExecutorAddr	WrapperFnAddr,
		FnT &&	OnComplete,
		ArrayRef< char >	ArgBuffer
	)

inline

Run a wrapper function in the executor using the given Runner to dispatch OnComplete when the result is ready.

Definition at line 342 of file ExecutorProcessControl.h.

References callWrapperAsync().

◆ disconnect()

virtual Error llvm::orc::ExecutorProcessControl::disconnect ( )

pure virtual

Disconnect from the target process.

This should be called after the JIT session is shut down.

Implemented in llvm::orc::UnsupportedExecutorProcessControl, llvm::orc::SelfExecutorProcessControl, and llvm::orc::SimpleRemoteEPC.

◆ getBootstrapMap()

const StringMap< std::vector< char > > & llvm::orc::ExecutorProcessControl::getBootstrapMap ( ) const

inline

Returns the bootstrap map.

Definition at line 233 of file ExecutorProcessControl.h.

References BootstrapMap.

◆ getBootstrapMapValue()

template<typename T , typename SPSTagT >

Error llvm::orc::ExecutorProcessControl::getBootstrapMapValue	(	StringRef	Key,
		std::optional< T > &	Val
	)		const

inline

Look up and SPS-deserialize a bootstrap map value.

Definition at line 241 of file ExecutorProcessControl.h.

References BootstrapMap, llvm::StringMap< ValueTy, AllocatorTy >::end(), llvm::StringMap< ValueTy, AllocatorTy >::find(), I, llvm::inconvertibleErrorCode(), and llvm::Error::success().

◆ getBootstrapSymbols()

Error llvm::orc::ExecutorProcessControl::getBootstrapSymbols ( ArrayRef< std::pair< ExecutorAddr &, StringRef > > Pairs ) const

inline

For each (ExecutorAddr&, StringRef) pair, looks up the string in the bootstrap symbols map and writes its address to the ExecutorAddr if found.

If any symbol is not found then the function returns an error.

Definition at line 267 of file ExecutorProcessControl.h.

References BootstrapSymbols, I, llvm::inconvertibleErrorCode(), and llvm::Error::success().

Referenced by llvm::orc::EPCEHFrameRegistrar::Create(), llvm::orc::EPCGenericDylibManager::CreateWithDefaultBootstrapSymbols(), and llvm::orc::EPCGenericRTDyldMemoryManager::CreateWithDefaultBootstrapSymbols().

◆ getBootstrapSymbolsMap()

const StringMap< ExecutorAddr > & llvm::orc::ExecutorProcessControl::getBootstrapSymbolsMap ( ) const

inline

Returns the bootstrap symbol map.

Definition at line 260 of file ExecutorProcessControl.h.

References BootstrapSymbols.

◆ getDispatcher()

TaskDispatcher & llvm::orc::ExecutorProcessControl::getDispatcher ( )

inline

Definition at line 209 of file ExecutorProcessControl.h.

References D.

◆ getExecutionSession()

ExecutionSession & llvm::orc::ExecutorProcessControl::getExecutionSession ( )

inline

Return the ExecutionSession associated with this instance.

Not callable until the ExecutionSession has been associated.

Definition at line 198 of file ExecutorProcessControl.h.

References assert(), and ES.

Referenced by llvm::orc::PerfSupportPlugin::Create(), llvm::orc::VTuneSupportPlugin::Create(), and llvm::orc::PerfSupportPlugin::modifyPassConfig().

◆ getJITDispatchInfo()

const JITDispatchInfo & llvm::orc::ExecutorProcessControl::getJITDispatchInfo ( ) const

inline

Get the JIT dispatch function and context address for the executor.

Definition at line 218 of file ExecutorProcessControl.h.

References JDI.

◆ getMemMgr()

jitlink::JITLinkMemoryManager & llvm::orc::ExecutorProcessControl::getMemMgr ( ) const

inline

Return a JITLinkMemoryManager for the target process.

Definition at line 227 of file ExecutorProcessControl.h.

References assert(), and MemMgr.

◆ getMemoryAccess()

MemoryAccess & llvm::orc::ExecutorProcessControl::getMemoryAccess ( ) const

inline

Return a MemoryAccess object for the target process.

Definition at line 221 of file ExecutorProcessControl.h.

References assert(), and MemAccess.

◆ getPageSize()

unsigned llvm::orc::ExecutorProcessControl::getPageSize ( ) const

inline

Get the page size for the target process.

Definition at line 215 of file ExecutorProcessControl.h.

References PageSize.

Referenced by llvm::orc::EPCGenericJITLinkMemoryManager::allocate(), llvm::orc::EPCGenericJITLinkMemoryManager::InFlightAlloc::finalize(), and llvm::orc::EPCGenericRTDyldMemoryManager::reserveAllocationSpace().

◆ getSymbolStringPool()

std::shared_ptr< SymbolStringPool > llvm::orc::ExecutorProcessControl::getSymbolStringPool ( ) const

inline

Return a shared pointer to the SymbolStringPool for this instance.

Definition at line 207 of file ExecutorProcessControl.h.

References SSP.

◆ getTargetTriple()

const Triple & llvm::orc::ExecutorProcessControl::getTargetTriple ( ) const

inline

Return the Triple for the target process.

Definition at line 212 of file ExecutorProcessControl.h.

References TargetTriple.

Referenced by llvm::orc::EPCIndirectionUtils::Create(), and llvm::orc::PerfSupportPlugin::Create().

◆ intern()

SymbolStringPtr llvm::orc::ExecutorProcessControl::intern ( StringRef SymName )

inline

Intern a symbol name in the SymbolStringPool.

Definition at line 204 of file ExecutorProcessControl.h.

References SSP.

◆ loadDylib()

virtual Expected< tpctypes::DylibHandle > llvm::orc::ExecutorProcessControl::loadDylib ( const char * DylibPath )

pure virtual

Load the dynamic library at the given path and return a handle to it.

If LibraryPath is null this function will return the global handle for the target process.

Implemented in llvm::orc::UnsupportedExecutorProcessControl, llvm::orc::SelfExecutorProcessControl, and llvm::orc::SimpleRemoteEPC.

Referenced by llvm::orc::EPCDynamicLibrarySearchGenerator::Load().

◆ lookupSymbols()

Expected< std::vector< tpctypes::LookupResult > > llvm::orc::ExecutorProcessControl::lookupSymbols ( ArrayRef< LookupRequest > Request )

inline

Search for symbols in the target process.

The result of the lookup is a 2-dimensional array of target addresses that correspond to the lookup order. If a required symbol is not found then this method will return an error. If a weakly referenced symbol is not found then it be assigned a '0' value.

Definition at line 294 of file ExecutorProcessControl.h.

References lookupSymbolsAsync(), and llvm::orc::Result.

Referenced by llvm::orc::lookupAndRecordAddrs().

◆ lookupSymbolsAsync()

virtual void llvm::orc::ExecutorProcessControl::lookupSymbolsAsync	(	ArrayRef< LookupRequest >	Request,
		SymbolLookupCompleteFn	F
	)

pure virtual

Search for symbols in the target process.

The result of the lookup is a 2-dimensional array of target addresses that correspond to the lookup order. If a required symbol is not found then this method will return an error. If a weakly referenced symbol is not found then it be assigned a '0' value.

Implemented in llvm::orc::UnsupportedExecutorProcessControl, llvm::orc::SelfExecutorProcessControl, and llvm::orc::SimpleRemoteEPC.

Referenced by lookupSymbols(), and llvm::orc::EPCDynamicLibrarySearchGenerator::tryToGenerate().