#include "llvm/ExecutionEngine/RuntimeDyld.h"

Classes
class	LoadedObjectInfo
	Information about the loaded object. More...

class	MemoryManager
	Memory Management. More...

Public Member Functions
	RuntimeDyld (MemoryManager &MemMgr, JITSymbolResolver &Resolver)
	Construct a RuntimeDyld instance. More...

	RuntimeDyld (const RuntimeDyld &)=delete

RuntimeDyld &	operator= (const RuntimeDyld &)=delete

	~RuntimeDyld ()

std::unique_ptr< LoadedObjectInfo >	loadObject (const object::ObjectFile &O)
	Add the referenced object file to the list of objects to be loaded and relocated. More...

void *	getSymbolLocalAddress (StringRef Name) const
	Get the address of our local copy of the symbol. More...

JITEvaluatedSymbol	getSymbol (StringRef Name) const
	Get the target address and flags for the named symbol. More...

std::map< StringRef, JITEvaluatedSymbol >	getSymbolTable () const
	Returns a copy of the symbol table. More...

void	resolveRelocations ()
	Resolve the relocations for all symbols we currently know about. More...

void	mapSectionAddress (const void *LocalAddress, uint64_t TargetAddress)
	Map a section to its target address space value. More...

void	registerEHFrames ()
	Register any EH frame sections that have been loaded but not previously registered with the memory manager. More...

void	deregisterEHFrames ()

bool	hasError ()

StringRef	getErrorString ()

void	setProcessAllSections (bool ProcessAllSections)
	By default, only sections that are "required for execution" are passed to the RTDyldMemoryManager, and other sections are discarded. More...

void	finalizeWithMemoryManagerLocking ()
	Perform all actions needed to make the code owned by this RuntimeDyld instance executable: More...

Protected Member Functions
void	reassignSectionAddress (unsigned SectionID, uint64_t Addr)

Friends
class	RuntimeDyldCheckerImpl

void	jitLinkForORC (object::ObjectFile &Obj, std::unique_ptr< MemoryBuffer > UnderlyingBuffer, RuntimeDyld::MemoryManager &MemMgr, JITSymbolResolver &Resolver, bool ProcessAllSections, std::function< Error(std::unique_ptr< LoadedObjectInfo >, std::map< StringRef, JITEvaluatedSymbol >)> OnLoaded, std::function< void(Error)> OnEmitted)

Detailed Description

Definition at line 59 of file RuntimeDyld.h.

Constructor & Destructor Documentation

◆ RuntimeDyld() [1/2]

llvm::RuntimeDyld::RuntimeDyld	(	RuntimeDyld::MemoryManager &	MemMgr,
		JITSymbolResolver &	Resolver
	)

Construct a RuntimeDyld instance.

Definition at line 1194 of file RuntimeDyld.cpp.

◆ RuntimeDyld() [2/2]

llvm::RuntimeDyld::RuntimeDyld ( const RuntimeDyld & )

delete

◆ ~RuntimeDyld()

llvm::RuntimeDyld::~RuntimeDyld ( )

Definition at line 1208 of file RuntimeDyld.cpp.

Member Function Documentation

◆ deregisterEHFrames()

void llvm::RuntimeDyld::deregisterEHFrames ( )

Definition at line 1320 of file RuntimeDyld.cpp.

◆ finalizeWithMemoryManagerLocking()

void llvm::RuntimeDyld::finalizeWithMemoryManagerLocking ( )

Perform all actions needed to make the code owned by this RuntimeDyld instance executable:

1) Apply relocations. 2) Register EH frames. 3) Update memory permissions*.

Finalization is potentially recursive**, and the 3rd step will only be applied by the outermost call to finalize. This allows different RuntimeDyld instances to share a memory manager without the innermost finalization locking the memory and causing relocation fixup errors in outer instances.

** Recursive finalization occurs when one RuntimeDyld instances needs the address of a symbol owned by some other instance in order to apply relocations.

Definition at line 1304 of file RuntimeDyld.cpp.

References llvm::RuntimeDyld::MemoryManager::finalizeMemory(), registerEHFrames(), and resolveRelocations().

◆ getErrorString()

StringRef llvm::RuntimeDyld::getErrorString ( )

Definition at line 1302 of file RuntimeDyld.cpp.

Referenced by llvm::jitLinkForORC().

◆ getSymbol()

JITEvaluatedSymbol llvm::RuntimeDyld::getSymbol ( StringRef Name ) const

Get the target address and flags for the named symbol.

This address is the one used for relocation.

Definition at line 1277 of file RuntimeDyld.cpp.

◆ getSymbolLocalAddress()

void * llvm::RuntimeDyld::getSymbolLocalAddress ( StringRef Name ) const

Get the address of our local copy of the symbol.

This may or may not be the address used for relocation (clients can copy the data around and resolve relocatons based on where they put it).

Definition at line 1271 of file RuntimeDyld.cpp.

◆ getSymbolTable()

std::map< StringRef, JITEvaluatedSymbol > llvm::RuntimeDyld::getSymbolTable ( ) const

Returns a copy of the symbol table.

This can be used by on-finalized callbacks to extract the symbol table before throwing away the RuntimeDyld instance. Because the map keys (StringRefs) are backed by strings inside the RuntimeDyld instance, the map should be processed before the RuntimeDyld instance is discarded.

Definition at line 1283 of file RuntimeDyld.cpp.

◆ hasError()

bool llvm::RuntimeDyld::hasError ( )

Definition at line 1300 of file RuntimeDyld.cpp.

Referenced by llvm::jitLinkForORC().

◆ loadObject()

std::unique_ptr< RuntimeDyld::LoadedObjectInfo > llvm::RuntimeDyld::loadObject ( const object::ObjectFile & O )

Add the referenced object file to the list of objects to be loaded and relocated.

Definition at line 1245 of file RuntimeDyld.cpp.

References llvm::createRuntimeDyldCOFF(), llvm::createRuntimeDyldELF(), llvm::createRuntimeDyldMachO(), llvm::object::ObjectFile::getArch(), llvm::object::Binary::isCOFF(), llvm::object::Binary::isELF(), llvm::object::Binary::isMachO(), llvm::RuntimeDyld::MemoryManager::notifyObjectLoaded(), and llvm::report_fatal_error().

Referenced by llvm::jitLinkForORC().

◆ mapSectionAddress()

void llvm::RuntimeDyld::mapSectionAddress	(	const void *	LocalAddress,
		uint64_t	TargetAddress
	)

Map a section to its target address space value.

Map the address of a JIT section as returned from the memory manager to the address in the target process as the running code will see it. This is the address which will be used for relocation resolution.

Definition at line 1295 of file RuntimeDyld.cpp.

Referenced by llvm::MCJIT::mapSectionAddress().

◆ operator=()

RuntimeDyld& llvm::RuntimeDyld::operator= ( const RuntimeDyld & )

delete

◆ reassignSectionAddress()

void llvm::RuntimeDyld::reassignSectionAddress	(	unsigned	SectionID,
		uint64_t	Addr
	)

protected

Definition at line 1291 of file RuntimeDyld.cpp.

◆ registerEHFrames()

void llvm::RuntimeDyld::registerEHFrames ( )

Register any EH frame sections that have been loaded but not previously registered with the memory manager.

Note, RuntimeDyld is responsible for identifying the EH frame and calling the memory manager with the EH frame section data. However, the memory manager itself will handle the actual target-specific EH frame registration.

Definition at line 1315 of file RuntimeDyld.cpp.

Referenced by finalizeWithMemoryManagerLocking().

◆ resolveRelocations()

void llvm::RuntimeDyld::resolveRelocations ( )

Resolve the relocations for all symbols we currently know about.

Definition at line 1289 of file RuntimeDyld.cpp.

Referenced by finalizeWithMemoryManagerLocking().

◆ setProcessAllSections()

void llvm::RuntimeDyld::setProcessAllSections ( bool ProcessAllSections )

inline

By default, only sections that are "required for execution" are passed to the RTDyldMemoryManager, and other sections are discarded.

Passing 'true' to this method will cause RuntimeDyld to pass all sections to its memory manager regardless of whether they are "required to execute" in the usual sense. This is useful for inspecting metadata sections that may not contain relocations, E.g. Debug info, stackmaps.

Must be called before the first object file is loaded.

Definition at line 228 of file RuntimeDyld.h.

References assert(), llvm::lltok::Error, function, and llvm::jitLinkForORC().

Referenced by llvm::jitLinkForORC(), and llvm::MCJIT::setProcessAllSections().

Friends And Related Function Documentation

◆ jitLinkForORC

void jitLinkForORC	(	object::ObjectFile &	Obj,
		std::unique_ptr< MemoryBuffer >	UnderlyingBuffer,
		RuntimeDyld::MemoryManager &	MemMgr,
		JITSymbolResolver &	Resolver,
		bool	ProcessAllSections,
		std::function< Error(std::unique_ptr< LoadedObjectInfo >, std::map< StringRef, JITEvaluatedSymbol >)>	OnLoaded,
		std::function< void(Error)>	OnEmitted
	)

friend

◆ RuntimeDyldCheckerImpl

friend class RuntimeDyldCheckerImpl

friend

Definition at line 60 of file RuntimeDyld.h.

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

include/llvm/ExecutionEngine/RuntimeDyld.h
lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp

Classes

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ RuntimeDyld() [1/2]

◆ RuntimeDyld() [2/2]

◆ ~RuntimeDyld()

Member Function Documentation

◆ deregisterEHFrames()

◆ finalizeWithMemoryManagerLocking()

◆ getErrorString()

◆ getSymbol()

◆ getSymbolLocalAddress()

◆ getSymbolTable()

◆ hasError()

◆ loadObject()

◆ mapSectionAddress()

◆ operator=()

◆ reassignSectionAddress()

◆ registerEHFrames()

◆ resolveRelocations()

◆ setProcessAllSections()

Friends And Related Function Documentation

◆ jitLinkForORC

◆ RuntimeDyldCheckerImpl