An ExecutionSession represents a running JIT program. More...

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

Classes
class	CallControllerHandlerBinding
	Associates a call-controller handler with the name of the tag symbol that the executor will use to call it, and the SymbolLookupFlags to use when looking that tag up. More...

Public Types
using	ErrorReporter = unique_function<void(Error)>
	For reporting errors.
using	CallControllerReturnFn
	Function type for returning results from a call-controller handler.
using	CallControllerHandlerFn
	A call-controller handler: handles calls from the executor made via the ORC runtime's call-controller mechanism.

Public Member Functions
LLVM_ABI	ExecutionSession (std::unique_ptr< ExecutorProcessControl > EPC)
	Construct an ExecutionSession with the given ExecutorProcessControl object.
	ExecutionSession (const ExecutionSession &)=delete
ExecutionSession &	operator= (const ExecutionSession &)=delete
	ExecutionSession (ExecutionSession &&)=delete
ExecutionSession &	operator= (ExecutionSession &&)=delete
LLVM_ABI	~ExecutionSession ()
	Destroy an ExecutionSession.
LLVM_ABI Error	endSession ()
	End the session.
ExecutorProcessControl &	getExecutorProcessControl ()
	Get the ExecutorProcessControl object associated with this ExecutionSession.
const Triple &	getTargetTriple () const
	Return the triple for the executor.
size_t	getPageSize () const
std::shared_ptr< SymbolStringPool >	getSymbolStringPool ()
	Get the SymbolStringPool for this instance.
SymbolStringPtr	intern (StringRef SymName)
	Add a symbol name to the SymbolStringPool and return a pointer to it.
JITDylib &	getBootstrapJITDylib ()
	Returns a reference to the bootstrap JITDylib.
void	setWaitingOnGraphOpRecorder (WaitingOnGraph::OpRecorder &R)
	Set a WaitingOnGraph::Recorder to capture WaitingOnGraph operations.
void	setPlatform (std::unique_ptr< Platform > P)
	Set the Platform for this ExecutionSession.
Platform *	getPlatform ()
	Get the Platform for this session.
template<typename Func>
decltype(auto)	runSessionLocked (Func &&F)
	Run the given lambda with the session mutex locked.
LLVM_ABI void	registerResourceManager (ResourceManager &RM)
	Register the given ResourceManager with this ExecutionSession.
LLVM_ABI void	deregisterResourceManager (ResourceManager &RM)
	Deregister the given ResourceManager with this ExecutionSession.
LLVM_ABI JITDylib *	getJITDylibByName (StringRef Name)
	Return a pointer to the "name" JITDylib.
LLVM_ABI JITDylib &	createBareJITDylib (std::string Name)
	Add a new bare JITDylib to this ExecutionSession.
LLVM_ABI Expected< JITDylib & >	createJITDylib (std::string Name)
	Add a new JITDylib to this ExecutionSession.
LLVM_ABI Error	removeJITDylibs (std::vector< JITDylibSP > JDsToRemove)
	Removes the given JITDylibs from the ExecutionSession.
Error	removeJITDylib (JITDylib &JD)
	Calls removeJTIDylibs on the gives JITDylib.
ExecutionSession &	setErrorReporter (ErrorReporter ReportError)
	Set the error reporter function.
void	reportError (Error Err)
	Report a error for this execution session.
LLVM_ABI void	lookupFlags (LookupKind K, JITDylibSearchOrder SearchOrder, SymbolLookupSet Symbols, unique_function< void(Expected< SymbolFlagsMap >)> OnComplete)
	Search the given JITDylibs to find the flags associated with each of the given symbols.
LLVM_ABI Expected< SymbolFlagsMap >	lookupFlags (LookupKind K, JITDylibSearchOrder SearchOrder, SymbolLookupSet Symbols)
	Blocking version of lookupFlags.
LLVM_ABI void	lookup (LookupKind K, const JITDylibSearchOrder &SearchOrder, SymbolLookupSet Symbols, SymbolState RequiredState, SymbolsResolvedCallback NotifyComplete, RegisterDependenciesFunction RegisterDependencies)
	Search the given JITDylibs for the given symbols.
LLVM_ABI Expected< SymbolMap >	lookup (const JITDylibSearchOrder &SearchOrder, SymbolLookupSet Symbols, LookupKind K=LookupKind::Static, SymbolState RequiredState=SymbolState::Ready, RegisterDependenciesFunction RegisterDependencies=NoDependenciesToRegister)
	Blocking version of lookup above.
LLVM_ABI Expected< ExecutorSymbolDef >	lookup (const JITDylibSearchOrder &SearchOrder, SymbolStringPtr Symbol, SymbolState RequiredState=SymbolState::Ready)
	Convenience version of blocking lookup.
LLVM_ABI Expected< ExecutorSymbolDef >	lookup (ArrayRef< JITDylib * > SearchOrder, SymbolStringPtr Symbol, SymbolState RequiredState=SymbolState::Ready)
	Convenience version of blocking lookup.
LLVM_ABI Expected< ExecutorSymbolDef >	lookup (ArrayRef< JITDylib * > SearchOrder, StringRef Symbol, SymbolState RequiredState=SymbolState::Ready)
	Convenience version of blocking lookup.
void	dispatchTask (std::unique_ptr< Task > T)
	Materialize the given unit.
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.
void	callWrapperAsync (ExecutorAddr WrapperFnAddr, ExecutorProcessControl::IncomingWFRHandler OnComplete, ArrayRef< char > ArgBuffer)
	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.
LLVM_ABI Error	registerCallControllerHandlers (JITDylib &JD, std::vector< CallControllerHandlerBinding > Hs)
	For each binding, look up its tag symbol in JD and register the binding's call-controller handler for the tag's address.
template<typename... BindingTs>
std::enable_if_t<(std::is_same_v< BindingTs, CallControllerHandlerBinding > &&...), Error >	registerCallControllerHandlers (JITDylib &JD, BindingTs &&...Hs)
	Convenience overload of registerCallControllerHandlers that takes the bindings as arguments, so that they can be constructed inline at the call site.
LLVM_ABI void	runCallControllerHandler (CallControllerReturnFn Return, ExecutorAddr HandlerFnTagAddr, shared::WrapperFunctionBuffer ArgBytes)
	Run the call-controller handler registered for the given tag address.
LLVM_ABI void	dump (raw_ostream &OS)
	Dump the state of all the JITDylibs in this session.

Friends
class	InProgressLookupFlagsState
class	InProgressFullLookupState
class	JITDylib
class	LookupState
class	MaterializationResponsibility
class	ResourceTracker

Detailed Description

An ExecutionSession represents a running JIT program.

Definition at line 1112 of file Core.h.

Member Typedef Documentation

◆ CallControllerHandlerFn

using llvm::orc::ExecutionSession::CallControllerHandlerFn

Initial value:

unique_function<void(

CallControllerReturnFn, shared::WrapperFunctionBuffer)>

llvm::orc::ExecutionSession::CallControllerReturnFn

unique_function< void(shared::WrapperFunctionBuffer)> CallControllerReturnFn

Function type for returning results from a call-controller handler.

Definition Core.h:1125

llvm::orc::shared::WrapperFunctionBuffer

C++ wrapper function buffer: Same as CWrapperFunctionBuffer but auto-releases memory.

Definition WrapperFunctionUtils.h:40

llvm::unique_function

unique_function is a type-erasing functor similar to std::function.

Definition FunctionExtras.h:55

A call-controller handler: handles calls from the executor made via the ORC runtime's call-controller mechanism.

Definition at line 1130 of file Core.h.

◆ CallControllerReturnFn

using llvm::orc::ExecutionSession::CallControllerReturnFn

Initial value:

unique_function<void(shared::WrapperFunctionBuffer)>

Function type for returning results from a call-controller handler.

Definition at line 1125 of file Core.h.

◆ ErrorReporter

using llvm::orc::ExecutionSession::ErrorReporter = unique_function<void(Error)>

For reporting errors.

Definition at line 1122 of file Core.h.

Constructor & Destructor Documentation

◆ ExecutionSession() [1/3]

llvm::orc::ExecutionSession::ExecutionSession ( std::unique_ptr< ExecutorProcessControl > EPC )

Construct an ExecutionSession with the given ExecutorProcessControl object.

Definition at line 1553 of file Core.cpp.

References llvm::orc::absoluteSymbols(), llvm::cantFail(), createBareJITDylib(), llvm::JITSymbolFlags::Exported, intern(), and llvm::move().

Referenced by ExecutionSession(), ExecutionSession(), operator=(), operator=(), and setErrorReporter().

◆ ExecutionSession() [2/3]

llvm::orc::ExecutionSession::ExecutionSession ( const ExecutionSession & )

delete

References ExecutionSession().

◆ ExecutionSession() [3/3]

llvm::orc::ExecutionSession::ExecutionSession ( ExecutionSession && )

delete

References ExecutionSession().

◆ ~ExecutionSession()

llvm::orc::ExecutionSession::~ExecutionSession ( )

Destroy an ExecutionSession.

Verifies that endSession was called prior to destruction.

Definition at line 1566 of file Core.cpp.

References assert().

Member Function Documentation

◆ callWrapperAsync() [1/3]

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

inline

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:

CWrapperFunctionBuffer fn(uint8_t *Data, uint64_t Size);

uint64_t

unsigned uint64_t

Definition AMDGPUDisassembler.cpp:540

InlinePriorityMode::Size

@ Size

Definition InlineOrder.cpp:25

uint8_t

llvm::Data

@ Data

Definition SIMachineScheduler.h:55

{.cpp}

Definition at line 1402 of file Core.h.

Referenced by llvm::orc::sps::ProxySpec< ProxyT, CI, RetT(ArgTs...)>::dispatch().

◆ callWrapperAsync() [2/3]

template<typename FnT>

void llvm::orc::ExecutionSession::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 1420 of file Core.h.

◆ callWrapperAsync() [3/3]

template<typename RunPolicyT, typename FnT>

void llvm::orc::ExecutionSession::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 1411 of file Core.h.

◆ createBareJITDylib()

JITDylib & llvm::orc::ExecutionSession::createBareJITDylib ( std::string Name )

Add a new bare JITDylib to this ExecutionSession.

The JITDylib Name is required to be unique. Clients should verify that names are not being re-used (E.g. by calling getJITDylibByName) if names are based on user input.

This call does not install any library code or symbols into the newly created JITDylib. The client is responsible for all configuration.

Definition at line 1626 of file Core.cpp.

References assert(), getJITDylibByName(), JITDylib, and runSessionLocked().

Referenced by createJITDylib(), ExecutionSession(), llvm::orc::ExecutorNativePlatform::operator()(), llvm::orc::LLJITBuilderState::prepareForConstruction(), and llvm::orc::LLJIT::setUpGenericLLVMIRPlatform.

◆ createJITDylib()

Expected< JITDylib & > llvm::orc::ExecutionSession::createJITDylib ( std::string Name )

Add a new JITDylib to this ExecutionSession.

The JITDylib Name is required to be unique. Clients should verify that names are not being re-used (e.g. by calling getJITDylibByName) if names are based on user input.

If a Platform is attached then Platform::setupJITDylib will be called to install standard platform symbols (e.g. standard library interposes). If no Platform is attached this call is equivalent to createBareJITDylib.

Definition at line 1635 of file Core.cpp.

References createBareJITDylib().

◆ deregisterResourceManager()

void llvm::orc::ExecutionSession::deregisterResourceManager ( ResourceManager & RM )

Deregister the given ResourceManager with this ExecutionSession.

Manager must have been previously registered.

Definition at line 1604 of file Core.cpp.

References assert(), llvm::find(), I, and runSessionLocked().

Referenced by llvm::orc::LinkGraphLinkingLayer::~LinkGraphLinkingLayer().

◆ dispatchTask()

void llvm::orc::ExecutionSession::dispatchTask ( std::unique_ptr< Task > T )

inline

Materialize the given unit.

Definition at line 1364 of file Core.h.

References assert(), DEBUG_WITH_TYPE, and T.

◆ dump()

void llvm::orc::ExecutionSession::dump ( raw_ostream & OS )

Dump the state of all the JITDylibs in this session.

Definition at line 1936 of file Core.cpp.

References runSessionLocked().

◆ endSession()

Error llvm::orc::ExecutionSession::endSession ( )

End the session.

Closes all JITDylibs and disconnects from the executor. Clients must call this method before destroying the session.

Definition at line 1572 of file Core.cpp.

References llvm::dbgs(), llvm::joinErrors(), LLVM_DEBUG, removeJITDylibs(), and runSessionLocked().

◆ getBootstrapJITDylib()

JITDylib & llvm::orc::ExecutionSession::getBootstrapJITDylib ( )

inline

Returns a reference to the bootstrap JITDylib.

This is a bare JITDylib that is created for each ExecutionSession and populated with the bootstrap symbol definitions provided by the ExecutorProcessControl object.

Definition at line 1200 of file Core.h.

References JITDylib.

Referenced by llvm::orc::EHFrameRegistrationPlugin::Create(), llvm::orc::UnwindInfoRegistrationPlugin::Create(), llvm::orc::sps::createEPCGenericDylibManager(), llvm::orc::sps::createEPCGenericJITLinkMemoryManager(), llvm::orc::sps::createEPCGenericMemoryAccess(), llvm::orc::sps::createSharedMemoryMapBindings(), and llvm::orc::sps::createSimpleMemoryMapBindings().

◆ getBootstrapMap()

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

inline

Returns the bootstrap map.

Definition at line 1371 of file Core.h.

◆ getBootstrapMapValue()

template<typename T, typename SPSTagT>

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

inline

Look up and SPS-deserialize a bootstrap map value.

Definition at line 1377 of file Core.h.

References llvm::InnerAnalysisManagerProxy< AnalysisManagerT, IRUnitT, ExtraArgTs... >::Key, and T.

Referenced by llvm::orc::LLJIT::setUpGenericLLVMIRPlatform.

◆ getBootstrapSymbols()

Error llvm::orc::ExecutionSession::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 1389 of file Core.h.

◆ getBootstrapSymbolsMap()

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

inline

Returns the bootstrap symbol map.

Definition at line 1382 of file Core.h.

◆ getExecutorProcessControl()

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

inline

Get the ExecutorProcessControl object associated with this ExecutionSession.

Definition at line 1179 of file Core.h.

◆ getJITDylibByName()

JITDylib * llvm::orc::ExecutionSession::getJITDylibByName ( StringRef Name )

Return a pointer to the "name" JITDylib.

Ownership of JITDylib remains within Execution Session

Definition at line 1617 of file Core.cpp.

References JITDylib, and runSessionLocked().

Referenced by createBareJITDylib().

◆ getPageSize()

size_t llvm::orc::ExecutionSession::getPageSize ( ) const

inline

Definition at line 1185 of file Core.h.

◆ getPlatform()

Platform * llvm::orc::ExecutionSession::getPlatform ( )

inline

Get the Platform for this session.

Will return null if no Platform has been set for this ExecutionSession.

Definition at line 1216 of file Core.h.

◆ getSymbolStringPool()

std::shared_ptr< SymbolStringPool > llvm::orc::ExecutionSession::getSymbolStringPool ( )

inline

Get the SymbolStringPool for this instance.

Definition at line 1188 of file Core.h.

◆ getTargetTriple()

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

inline

Return the triple for the executor.

Definition at line 1182 of file Core.h.

Referenced by llvm::orc::createHeaderBlock(), llvm::orc::getDylibInterfaceFromDylib(), llvm::orc::getDylibInterfaceFromTapiFile(), LLVMOrcLLJITBuilderSetObjectLinkingLayerCreator(), and registerCallControllerHandlers().

◆ intern()

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

inline

Add a symbol name to the SymbolStringPool and return a pointer to it.

Definition at line 1193 of file Core.h.

Referenced by llvm::orc::addAliases(), llvm::orc::addInitSymbol(), ExecutionSession(), llvm::orc::getCOFFObjectFileSymbolInfo(), llvm::orc::getDylibInterfaceFromDylib(), llvm::orc::getDylibInterfaceFromTapiFile(), llvm::orc::getELFObjectFileSymbolInfo(), llvm::orc::getGenericObjectFileSymbolInfo(), llvm::orc::getMachOObjectFileSymbolInfo(), llvm::orc::getXCOFFObjectFileSymbolInfo(), llvm::orc::IRMaterializationUnit::IRMaterializationUnit(), lookup(), registerCallControllerHandlers(), and llvm::orc::UnwindInfoRegistrationPlugin::UnwindInfoRegistrationPlugin().

◆ lookup() [1/5]

Expected< ExecutorSymbolDef > llvm::orc::ExecutionSession::lookup	(	ArrayRef< JITDylib * >	SearchOrder,
		StringRef	Symbol,
		SymbolState	RequiredState = SymbolState::Ready )

Convenience version of blocking lookup.

Searches each of the JITDylibs in the search order in turn for the given symbol. The search will not find non-exported symbols.

Definition at line 1854 of file Core.cpp.

References intern(), and lookup().

◆ lookup() [2/5]

Expected< ExecutorSymbolDef > llvm::orc::ExecutionSession::lookup	(	ArrayRef< JITDylib * >	SearchOrder,
		SymbolStringPtr	Symbol,
		SymbolState	RequiredState = SymbolState::Ready )

Convenience version of blocking lookup.

Searches each of the JITDylibs in the search order in turn for the given symbol. The search will not find non-exported symbols.

Definition at line 1848 of file Core.cpp.

References lookup(), and llvm::orc::makeJITDylibSearchOrder().

◆ lookup() [3/5]

Expected< SymbolMap > llvm::orc::ExecutionSession::lookup	(	const JITDylibSearchOrder &	SearchOrder,
		SymbolLookupSet	Symbols,
		LookupKind	K = LookupKind::Static,
		SymbolState	RequiredState = SymbolState::Ready,
		RegisterDependenciesFunction	RegisterDependencies = NoDependenciesToRegister )

Blocking version of lookup above.

Returns the resolved symbol map. If WaitUntilReady is true (the default), will not return until all requested symbols are ready (or an error occurs). If WaitUntilReady is false, will return as soon as all requested symbols are resolved, or an error occurs. If WaitUntilReady is false and an error occurs after resolution, the function will return a success value, but the error will be reported via reportErrors.

Definition at line 1794 of file Core.cpp.

References _, lookup(), llvm::orc::Result, and llvm::Error::success().

◆ lookup() [4/5]

Expected< ExecutorSymbolDef > llvm::orc::ExecutionSession::lookup	(	const JITDylibSearchOrder &	SearchOrder,
		SymbolStringPtr	Symbol,
		SymbolState	RequiredState = SymbolState::Ready )

Convenience version of blocking lookup.

Searches each of the JITDylibs in the search order in turn for the given symbol.

Definition at line 1834 of file Core.cpp.

References assert(), lookup(), llvm::orc::NoDependenciesToRegister, and llvm::orc::Static.

◆ lookup() [5/5]

void llvm::orc::ExecutionSession::lookup	(	LookupKind	K,
		const JITDylibSearchOrder &	SearchOrder,
		SymbolLookupSet	Symbols,
		SymbolState	RequiredState,
		SymbolsResolvedCallback	NotifyComplete,
		RegisterDependenciesFunction	RegisterDependencies )

Search the given JITDylibs for the given symbols.

SearchOrder lists the JITDylibs to search. For each dylib, the associated boolean indicates whether the search should match against non-exported (hidden visibility) symbols in that dylib (true means match against non-exported symbols, false means do not match).

The NotifyComplete callback will be called once all requested symbols reach the required state.

If all symbols are found, the RegisterDependencies function will be called while the session lock is held. This gives clients a chance to register dependencies for on the queried symbols for any symbols they are materializing (if a MaterializationResponsibility instance is present, this can be implemented by calling MaterializationResponsibility::addDependencies). If there are no dependenant symbols for this query (e.g. it is being made by a top level client to get an address to call) then the value NoDependenciesToRegister can be used.

Definition at line 1764 of file Core.cpp.

References llvm::dbgs(), LLVM_DEBUG, runSessionLocked(), and llvm::Error::success().

Referenced by llvm::orc::GDBJITDebugInfoRegistrationPlugin::Create(), lookup(), lookup(), lookup(), lookup(), llvm::orc::Platform::lookupInitSymbols(), llvm::orc::Platform::lookupInitSymbolsAsync(), and registerCallControllerHandlers().

◆ lookupFlags() [1/2]

Expected< SymbolFlagsMap > llvm::orc::ExecutionSession::lookupFlags	(	LookupKind	K,
		JITDylibSearchOrder	SearchOrder,
		SymbolLookupSet	Symbols )

Blocking version of lookupFlags.

Definition at line 1749 of file Core.cpp.

References llvm::Expected< T >::get(), llvm::orc::Result, and llvm::Error::success().

◆ lookupFlags() [2/2]

void llvm::orc::ExecutionSession::lookupFlags	(	LookupKind	K,
		JITDylibSearchOrder	SearchOrder,
		SymbolLookupSet	Symbols,
		unique_function< void(Expected< SymbolFlagsMap >)>	OnComplete )

Search the given JITDylibs to find the flags associated with each of the given symbols.

Definition at line 1738 of file Core.cpp.

References llvm::Error::success().

Referenced by llvm::orc::buildSimpleReexportsAliasMap(), and llvm::orc::ReexportsGenerator::tryToGenerate().

◆ operator=() [1/2]

ExecutionSession & llvm::orc::ExecutionSession::operator= ( const ExecutionSession & )

delete

References ExecutionSession().

◆ operator=() [2/2]

ExecutionSession & llvm::orc::ExecutionSession::operator= ( ExecutionSession && )

delete

References ExecutionSession(), and LLVM_ABI.

◆ registerCallControllerHandlers() [1/2]

template<typename... BindingTs>

std::enable_if_t<(std::is_same_v< BindingTs, CallControllerHandlerBinding > &&...), Error > llvm::orc::ExecutionSession::registerCallControllerHandlers	(	JITDylib &	JD,
		BindingTs &&...	Hs )

inline

Convenience overload of registerCallControllerHandlers that takes the bindings as arguments, so that they can be constructed inline at the call site.

Definition at line 1446 of file Core.h.

References JITDylib, and registerCallControllerHandlers().

◆ registerCallControllerHandlers() [2/2]

Error llvm::orc::ExecutionSession::registerCallControllerHandlers	(	JITDylib &	JD,
		std::vector< CallControllerHandlerBinding >	Hs )

For each binding, look up its tag symbol in JD and register the binding's call-controller handler for the tag's address.

The handler becomes callable from the executor via the ORC runtime's call-controller mechanism, using the tag's address as the handler tag.

Tag names are mangled for the session's target triple, then looked up in JD using LookupKind::Static and JITDylibLookupFlags::MatchAllSymbols (hidden tags will be found), with each binding's SymbolLookupFlags. If a weakly referenced tag is not found then its handler is dropped.

On failure no handlers are registered.

Definition at line 1859 of file Core.cpp.

References llvm::orc::SymbolLookupSet::add(), assert(), llvm::dbgs(), llvm::DenseMapBase< StorageT, KeyT, ValueT, KeyInfoT, BucketT >::end(), llvm::DenseMapBase< StorageT, KeyT, ValueT, KeyInfoT, BucketT >::find(), llvm::formatv(), getTargetTriple(), H, I, llvm::inconvertibleErrorCode(), intern(), JITDylib, LLVM_DEBUG, lookup(), llvm::make_error(), llvm::orc::MatchAllSymbols, N, llvm::Error::success(), and llvm::DenseMapBase< StorageT, KeyT, ValueT, KeyInfoT, BucketT >::try_emplace().

Referenced by registerCallControllerHandlers().

◆ registerResourceManager()

void llvm::orc::ExecutionSession::registerResourceManager ( ResourceManager & RM )

Register the given ResourceManager with this ExecutionSession.

Managers will be notified of events in reverse order of registration.

Definition at line 1600 of file Core.cpp.

References runSessionLocked().

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

◆ removeJITDylib()

Error llvm::orc::ExecutionSession::removeJITDylib ( JITDylib & JD )

inline

Calls removeJTIDylibs on the gives JITDylib.

Definition at line 1277 of file Core.h.

References JITDylib, and removeJITDylibs().

◆ removeJITDylibs()

Error llvm::orc::ExecutionSession::removeJITDylibs ( std::vector< JITDylibSP > JDsToRemove )

Removes the given JITDylibs from the ExecutionSession.

This method clears all resources held for the JITDylibs, puts them in the closed state, and clears all references to them that are held by the ExecutionSession or other JITDylibs. No further code can be added to the removed JITDylibs, and the JITDylib objects will be freed once any remaining JITDylibSPs pointing to them are destroyed.

This method does not run static destructors for code contained in the JITDylibs, and each JITDylib can only be removed once.

JITDylibs will be removed in the order given. Teardown is usually independent for each JITDylib, but not always. In particular, where the ORC runtime is used it is expected that teardown off all JITDylibs will depend on it, so the JITDylib containing the ORC runtime must be removed last. If the client has introduced any other dependencies they should be accounted for in the removal order too.

Definition at line 1643 of file Core.cpp.

References assert(), llvm::find(), I, llvm::joinErrors(), runSessionLocked(), and llvm::Error::success().

Referenced by endSession(), and removeJITDylib().

◆ reportError()

void llvm::orc::ExecutionSession::reportError ( Error Err )

inline

Report a error for this execution session.

Unhandled errors can be sent here to log them.

Definition at line 1290 of file Core.h.

Referenced by llvm::orc::SimpleRemoteEPC::callWrapperAsync(), llvm::orc::CompileOnDemandLayer::emit(), llvm::orc::IRCompileLayer::emit(), llvm::orc::IRTransformLayer::emit(), and llvm::orc::Speculator::registerSymbols().

◆ runCallControllerHandler()

void llvm::orc::ExecutionSession::runCallControllerHandler	(	CallControllerReturnFn	Return,
		ExecutorAddr	HandlerFnTagAddr,
		shared::WrapperFunctionBuffer	ArgBytes )

Run the call-controller handler registered for the given tag address.

This should be called by the ExecutorProcessControl instance in response to calls from the executor made via the ORC runtime's call-controller mechanism.

Definition at line 1913 of file Core.cpp.

References llvm::orc::shared::WrapperFunctionBuffer::createOutOfBandError(), llvm::formatv(), H, and I.

◆ runSessionLocked()

template<typename Func>

decltype(auto) llvm::orc::ExecutionSession::runSessionLocked ( Func && F )

inline

Run the given lambda with the session mutex locked.

Definition at line 1219 of file Core.h.

References F.

Referenced by createBareJITDylib(), deregisterResourceManager(), dump(), endSession(), getJITDylibByName(), llvm::orc::LazyReexportsManager::handleRemoveResources(), lookup(), registerResourceManager(), removeJITDylibs(), and llvm::orc::ResourceTracker::withResourceKeyDo().

◆ setErrorReporter()

ExecutionSession & llvm::orc::ExecutionSession::setErrorReporter ( ErrorReporter ReportError )

inline

Set the error reporter function.

Definition at line 1282 of file Core.h.

References ExecutionSession().

◆ setPlatform()

void llvm::orc::ExecutionSession::setPlatform ( std::unique_ptr< Platform > P )

inline

Set the Platform for this ExecutionSession.

Definition at line 1212 of file Core.h.

Referenced by llvm::orc::ExecutorNativePlatform::operator()().

◆ setWaitingOnGraphOpRecorder()

void llvm::orc::ExecutionSession::setWaitingOnGraphOpRecorder ( WaitingOnGraph::OpRecorder & R )

inline

Set a WaitingOnGraph::Recorder to capture WaitingOnGraph operations.

This method can be called at most once. If called, it should be called before any symbols are materialized.

Definition at line 1206 of file Core.h.

References assert().

◆ InProgressFullLookupState

friend class InProgressFullLookupState

friend

Definition at line 1114 of file Core.h.

References InProgressFullLookupState.

Referenced by InProgressFullLookupState.

◆ InProgressLookupFlagsState

friend class InProgressLookupFlagsState

friend

Definition at line 1113 of file Core.h.

References InProgressLookupFlagsState.

Referenced by InProgressLookupFlagsState.

◆ JITDylib

friend class JITDylib

friend

Definition at line 1115 of file Core.h.

References JITDylib.

Referenced by createBareJITDylib(), getBootstrapJITDylib(), getJITDylibByName(), JITDylib, registerCallControllerHandlers(), registerCallControllerHandlers(), and removeJITDylib().

◆ LookupState

friend class LookupState

friend

Definition at line 1116 of file Core.h.

References LookupState.

Referenced by LookupState.

◆ MaterializationResponsibility

friend class MaterializationResponsibility

friend

Definition at line 1117 of file Core.h.

References MaterializationResponsibility.

Referenced by MaterializationResponsibility.

◆ ResourceTracker

friend class ResourceTracker

friend

Definition at line 1118 of file Core.h.

References ResourceTracker.

Referenced by ResourceTracker.

The documentation for this class was generated from the following files:

include/llvm/ExecutionEngine/Orc/Core.h
lib/ExecutionEngine/Orc/Core.cpp

Classes

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ CallControllerHandlerFn

◆ CallControllerReturnFn

◆ ErrorReporter

Constructor & Destructor Documentation

◆ ExecutionSession() [1/3]

◆ ExecutionSession() [2/3]

◆ ExecutionSession() [3/3]

◆ ~ExecutionSession()

Member Function Documentation

◆ callWrapperAsync() [1/3]

◆ callWrapperAsync() [2/3]

◆ callWrapperAsync() [3/3]

◆ createBareJITDylib()

◆ createJITDylib()

◆ deregisterResourceManager()

◆ dispatchTask()

◆ dump()

◆ endSession()

◆ getBootstrapJITDylib()

◆ getBootstrapMap()

◆ getBootstrapMapValue()

◆ getBootstrapSymbols()

◆ getBootstrapSymbolsMap()

◆ getExecutorProcessControl()

◆ getJITDylibByName()

◆ getPageSize()

◆ getPlatform()

◆ getSymbolStringPool()

◆ getTargetTriple()

◆ intern()

◆ lookup() [1/5]

◆ lookup() [2/5]

◆ lookup() [3/5]

◆ lookup() [4/5]

◆ lookup() [5/5]

◆ lookupFlags() [1/2]

◆ lookupFlags() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ registerCallControllerHandlers() [1/2]

◆ registerCallControllerHandlers() [2/2]

◆ registerResourceManager()

◆ removeJITDylib()

◆ removeJITDylibs()

◆ reportError()

◆ runCallControllerHandler()

◆ runSessionLocked()

◆ setErrorReporter()

◆ setPlatform()

◆ setWaitingOnGraphOpRecorder()

Friends And Related Symbol Documentation

◆ InProgressFullLookupState

◆ InProgressLookupFlagsState

◆ JITDylib

◆ LookupState

◆ MaterializationResponsibility

◆ ResourceTracker