Bare bones object linking layer. More...

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

Inheritance diagram for llvm::orc::LegacyRTDyldObjectLinkingLayer:

Collaboration diagram for llvm::orc::LegacyRTDyldObjectLinkingLayer:

Classes
struct	Resources

Public Types
using	NotifyLoadedFtor = std::function< void(VModuleKey, const object::ObjectFile &Obj, const RuntimeDyld::LoadedObjectInfo &)>
	Functor for receiving object-loaded notifications. More...

using	NotifyFinalizedFtor = std::function< void(VModuleKey, const object::ObjectFile &Obj, const RuntimeDyld::LoadedObjectInfo &)>
	Functor for receiving finalization notifications. More...

using	NotifyFreedFtor = std::function< void(VModuleKey, const object::ObjectFile &Obj)>
	Functor for receiving deallocation notifications. More...

using	ResourcesGetter = std::function< Resources(VModuleKey)>

using	ObjectPtr = std::unique_ptr< MemoryBuffer >

Public Types inherited from llvm::orc::LegacyRTDyldObjectLinkingLayerBase
using	ObjectPtr = std::unique_ptr< MemoryBuffer >

Public Member Functions
	LegacyRTDyldObjectLinkingLayer (ExecutionSession &ES, ResourcesGetter GetResources, NotifyLoadedFtor NotifyLoaded=NotifyLoadedFtor(), NotifyFinalizedFtor NotifyFinalized=NotifyFinalizedFtor(), NotifyFreedFtor NotifyFreed=NotifyFreedFtor())
	Construct an ObjectLinkingLayer with the given NotifyLoaded, and NotifyFinalized functors. More...

void	setProcessAllSections (bool ProcessAllSections)
	Set the 'ProcessAllSections' flag. More...

Error	addObject (VModuleKey K, ObjectPtr ObjBuffer)
	Add an object to the JIT. More...

Error	removeObject (VModuleKey K)
	Remove the object associated with VModuleKey K. More...

JITSymbol	findSymbol (StringRef Name, bool ExportedSymbolsOnly)
	Search for the given named symbol. More...

JITSymbol	findSymbolIn (VModuleKey K, StringRef Name, bool ExportedSymbolsOnly)
	Search for the given named symbol in the context of the loaded object represented by the VModuleKey K. More...

void	mapSectionAddress (VModuleKey K, const void *LocalAddress, JITTargetAddress TargetAddr)
	Map section addresses for the object associated with the VModuleKey K. More...

Error	emitAndFinalize (VModuleKey K)
	Immediately emit and finalize the object represented by the given VModuleKey. More...

Detailed Description

Bare bones object linking layer.

This class is intended to be used as the base layer for a JIT. It allows object files to be loaded into memory, linked, and the addresses of their symbols queried. All objects added to this layer can see each other's symbols.

Definition at line 176 of file RTDyldObjectLinkingLayer.h.

Member Typedef Documentation

◆ NotifyFinalizedFtor

using llvm::orc::LegacyRTDyldObjectLinkingLayer::NotifyFinalizedFtor = std::function<void(VModuleKey, const object::ObjectFile &Obj, const RuntimeDyld::LoadedObjectInfo &)>

Functor for receiving finalization notifications.

Definition at line 189 of file RTDyldObjectLinkingLayer.h.

◆ NotifyFreedFtor

using llvm::orc::LegacyRTDyldObjectLinkingLayer::NotifyFreedFtor = std::function<void(VModuleKey, const object::ObjectFile &Obj)>

Functor for receiving deallocation notifications.

Definition at line 192 of file RTDyldObjectLinkingLayer.h.

◆ NotifyLoadedFtor

using llvm::orc::LegacyRTDyldObjectLinkingLayer::NotifyLoadedFtor = std::function<void(VModuleKey, const object::ObjectFile &Obj, const RuntimeDyld::LoadedObjectInfo &)>

Functor for receiving object-loaded notifications.

Definition at line 184 of file RTDyldObjectLinkingLayer.h.

◆ ObjectPtr

using llvm::orc::LegacyRTDyldObjectLinkingLayerBase::ObjectPtr = std::unique_ptr<MemoryBuffer>

Definition at line 126 of file RTDyldObjectLinkingLayer.h.

◆ ResourcesGetter

using llvm::orc::LegacyRTDyldObjectLinkingLayer::ResourcesGetter = std::function<Resources(VModuleKey)>

Definition at line 340 of file RTDyldObjectLinkingLayer.h.

Constructor & Destructor Documentation

◆ LegacyRTDyldObjectLinkingLayer()

llvm::orc::LegacyRTDyldObjectLinkingLayer::LegacyRTDyldObjectLinkingLayer	(	ExecutionSession &	ES,
		ResourcesGetter	GetResources,
		NotifyLoadedFtor	NotifyLoaded = `NotifyLoadedFtor()`,
		NotifyFinalizedFtor	NotifyFinalized = `NotifyFinalizedFtor()`,
		NotifyFreedFtor	NotifyFreed = `NotifyFreedFtor()`
	)

inline

Construct an ObjectLinkingLayer with the given NotifyLoaded, and NotifyFinalized functors.

Definition at line 344 of file RTDyldObjectLinkingLayer.h.

Member Function Documentation

◆ addObject()

Error llvm::orc::LegacyRTDyldObjectLinkingLayer::addObject	(	VModuleKey	K,
		ObjectPtr	ObjBuffer
	)

inline

Add an object to the JIT.

Definition at line 367 of file RTDyldObjectLinkingLayer.h.

References assert(), llvm::object::ObjectFile::createObjectFile(), and llvm::Error::success().

◆ emitAndFinalize()

Error llvm::orc::LegacyRTDyldObjectLinkingLayer::emitAndFinalize ( VModuleKey K )

inline

Immediately emit and finalize the object represented by the given VModuleKey.

Parameters

K	VModuleKey for object to emit/finalize.

Definition at line 438 of file RTDyldObjectLinkingLayer.h.

References assert().

◆ findSymbol()

JITSymbol llvm::orc::LegacyRTDyldObjectLinkingLayer::findSymbol	(	StringRef	Name,
		bool	ExportedSymbolsOnly
	)

inline

Search for the given named symbol.

Parameters

Name	The name of the symbol to search for.
ExportedSymbolsOnly	If true, search only for exported symbols.

Returns: A handle for the given named symbol, if it exists.

Definition at line 404 of file RTDyldObjectLinkingLayer.h.

◆ findSymbolIn()

JITSymbol llvm::orc::LegacyRTDyldObjectLinkingLayer::findSymbolIn	(	VModuleKey	K,
		StringRef	Name,
		bool	ExportedSymbolsOnly
	)

inline

Search for the given named symbol in the context of the loaded object represented by the VModuleKey K.

Parameters

K	The VModuleKey for the object to search in.
Name	The name of the symbol to search for.
ExportedSymbolsOnly	If true, search only for exported symbols.

Returns: A handle for the given named symbol, if it is found in the given object.

Definition at line 421 of file RTDyldObjectLinkingLayer.h.

References assert().

◆ mapSectionAddress()

void llvm::orc::LegacyRTDyldObjectLinkingLayer::mapSectionAddress	(	VModuleKey	K,
		const void *	LocalAddress,
		JITTargetAddress	TargetAddr
	)

inline

Map section addresses for the object associated with the VModuleKey K.

Definition at line 429 of file RTDyldObjectLinkingLayer.h.

References assert().

◆ removeObject()

Error llvm::orc::LegacyRTDyldObjectLinkingLayer::removeObject ( VModuleKey K )

inline

Remove the object associated with VModuleKey K.

All memory allocated for the object will be freed, and the sections and symbols it provided will no longer be available. No attempt is made to re-emit the missing symbols, and any use of these symbols (directly or indirectly) will result in undefined behavior. If dependence tracking is required to detect or resolve such issues it should be added at a higher layer.

Definition at line 393 of file RTDyldObjectLinkingLayer.h.

References assert(), and llvm::Error::success().

◆ setProcessAllSections()

void llvm::orc::LegacyRTDyldObjectLinkingLayer::setProcessAllSections ( bool ProcessAllSections )

inline

Set the 'ProcessAllSections' flag.

If set to true, all sections in each object file will be allocated using the memory manager, rather than just the sections required for execution.

This is kludgy, and may be removed in the future.

Definition at line 362 of file RTDyldObjectLinkingLayer.h.

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

include/llvm/ExecutionEngine/Orc/RTDyldObjectLinkingLayer.h

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ NotifyFinalizedFtor

◆ NotifyFreedFtor

◆ NotifyLoadedFtor

◆ ObjectPtr

◆ ResourcesGetter

Constructor & Destructor Documentation

◆ LegacyRTDyldObjectLinkingLayer()

Member Function Documentation

◆ addObject()

◆ emitAndFinalize()

◆ findSymbol()

◆ findSymbolIn()

◆ mapSectionAddress()

◆ removeObject()

◆ setProcessAllSections()