llvm::jitlink::InProcessMemoryManager Class Reference

A JITLinkMemoryManager that allocates in-process memory. More...

#include "llvm/ExecutionEngine/JITLink/JITLinkMemoryManager.h"

Inheritance diagram for llvm::jitlink::InProcessMemoryManager:

Classes
class	IPInFlightAlloc

Public Member Functions
	InProcessMemoryManager (uint64_t PageSize)
	Create an instance using the given page size.
void	allocate (const JITLinkDylib *JD, LinkGraph &G, OnAllocatedFunction OnAllocated) override
	Start the allocation process.
void	deallocate (std::vector< FinalizedAlloc > Alloc, OnDeallocatedFunction OnDeallocated) override
	Deallocate a list of allocation objects.
virtual void	allocate (const JITLinkDylib *JD, LinkGraph &G, OnAllocatedFunction OnAllocated)=0
	Start the allocation process.
AllocResult	allocate (const JITLinkDylib *JD, LinkGraph &G)
	Convenience function for blocking allocation.
virtual void	deallocate (std::vector< FinalizedAlloc > Allocs, OnDeallocatedFunction OnDeallocated)=0
	Deallocate a list of allocation objects.
void	deallocate (FinalizedAlloc Alloc, OnDeallocatedFunction OnDeallocated)
	Convenience function for deallocation of a single alloc.
Error	deallocate (std::vector< FinalizedAlloc > Allocs)
	Convenience function for blocking deallocation.
Error	deallocate (FinalizedAlloc Alloc)
	Convenience function for blocking deallocation of a single alloc.
Public Member Functions inherited from llvm::jitlink::JITLinkMemoryManager
virtual	~JITLinkMemoryManager ()
virtual void	allocate (const JITLinkDylib *JD, LinkGraph &G, OnAllocatedFunction OnAllocated)=0
	Start the allocation process.
AllocResult	allocate (const JITLinkDylib *JD, LinkGraph &G)
	Convenience function for blocking allocation.
virtual void	deallocate (std::vector< FinalizedAlloc > Allocs, OnDeallocatedFunction OnDeallocated)=0
	Deallocate a list of allocation objects.
void	deallocate (FinalizedAlloc Alloc, OnDeallocatedFunction OnDeallocated)
	Convenience function for deallocation of a single alloc.
Error	deallocate (std::vector< FinalizedAlloc > Allocs)
	Convenience function for blocking deallocation.
Error	deallocate (FinalizedAlloc Alloc)
	Convenience function for blocking deallocation of a single alloc.

Static Public Member Functions
static Expected< std::unique_ptr< InProcessMemoryManager > >	Create ()
	Attempts to auto-detect the host page size.

Additional Inherited Members
Public Types inherited from llvm::jitlink::JITLinkMemoryManager
using	AllocResult = Expected< std::unique_ptr< InFlightAlloc > >
	Typedef for the argument to be passed to OnAllocatedFunction.
using	OnAllocatedFunction = unique_function< void(AllocResult)>
	Called when allocation has been completed.
using	OnDeallocatedFunction = unique_function< void(Error)>
	Called when deallocation has completed.

Detailed Description

A JITLinkMemoryManager that allocates in-process memory.

Definition at line 363 of file JITLinkMemoryManager.h.

Constructor & Destructor Documentation

InProcessMemoryManager()

llvm::jitlink::InProcessMemoryManager::InProcessMemoryManager ( uint64_t  PageSize )

inline

Create an instance using the given page size.

Definition at line 371 of file JITLinkMemoryManager.h.

References assert(), llvm::isPowerOf2_64(), and PageSize.

Member Function Documentation

allocate() [1/3]

AllocResult llvm::jitlink::JITLinkMemoryManager::allocate ( const JITLinkDylib *  JD, LinkGraph &  G  )

inline

Convenience function for blocking allocation.

Definition at line 165 of file JITLinkMemoryManager.h.

allocate() [2/3]

void llvm::jitlink::InProcessMemoryManager::allocate ( const JITLinkDylib *  JD, LinkGraph &  G, OnAllocatedFunction  OnAllocated  )

overridevirtual

Start the allocation process.

If the initial allocation is successful then the OnAllocated function will be called with a std::unique_ptr<InFlightAlloc> value. If the assocation is unsuccessful then the OnAllocated function will be called with an Error.

Scan the request and calculate the group and total sizes. Check that segment size is no larger than a page.

Check that the total size requested (including zero fill) is not larger than a size_t.

Implements llvm::jitlink::JITLinkMemoryManager.

Definition at line 344 of file JITLinkMemoryManager.cpp.

References llvm::alignTo(), llvm::sys::MemoryBlock::allocatedSize(), llvm::sys::Memory::allocateMappedMemory(), llvm::sys::MemoryBlock::base(), llvm::dbgs(), llvm::errorCodeToError(), llvm::formatv(), llvm::orc::ExecutorAddr::fromPtr(), G, LLVM_DEBUG, llvm::sys::Memory::MF_READ, llvm::sys::Memory::MF_WRITE, and llvm::orc::Standard.

allocate() [3/3]

virtual void llvm::jitlink::JITLinkMemoryManager::allocate ( const JITLinkDylib *  JD, LinkGraph &  G, OnAllocatedFunction  OnAllocated  )

virtual

Start the allocation process.

If the initial allocation is successful then the OnAllocated function will be called with a std::unique_ptr<InFlightAlloc> value. If the assocation is unsuccessful then the OnAllocated function will be called with an Error.

Implements llvm::jitlink::JITLinkMemoryManager.

Create()

Expected< std::unique_ptr< InProcessMemoryManager > > llvm::jitlink::InProcessMemoryManager::Create ( )

static

Attempts to auto-detect the host page size.

Definition at line 330 of file JITLinkMemoryManager.cpp.

References llvm::sys::Process::getPageSize(), llvm::inconvertibleErrorCode(), and llvm::isPowerOf2_64().

deallocate() [1/5]

Error llvm::jitlink::JITLinkMemoryManager::deallocate ( FinalizedAlloc  Alloc )

inline

Convenience function for blocking deallocation of a single alloc.

Definition at line 198 of file JITLinkMemoryManager.h.

deallocate() [2/5]

void llvm::jitlink::JITLinkMemoryManager::deallocate ( FinalizedAlloc  Alloc, OnDeallocatedFunction  OnDeallocated  )

inline

Convenience function for deallocation of a single alloc.

Definition at line 182 of file JITLinkMemoryManager.h.

deallocate() [3/5]

void llvm::jitlink::InProcessMemoryManager::deallocate ( std::vector< FinalizedAlloc >  Allocs, OnDeallocatedFunction  OnDeallocated  )

overridevirtual

Deallocate a list of allocation objects.

Dealloc actions will be run in reverse order (from the end of the vector to the start).

Run any deallocate calls.

Release the standard segments slab.

Implements llvm::jitlink::JITLinkMemoryManager.

Definition at line 443 of file JITLinkMemoryManager.cpp.

References llvm::Alloc, llvm::errorCodeToError(), llvm::joinErrors(), llvm::sys::Memory::releaseMappedMemory(), and llvm::Error::success().

deallocate() [4/5]

Error llvm::jitlink::JITLinkMemoryManager::deallocate ( std::vector< FinalizedAlloc >  Allocs )

inline

Convenience function for blocking deallocation.

Definition at line 189 of file JITLinkMemoryManager.h.

deallocate() [5/5]

virtual void llvm::jitlink::JITLinkMemoryManager::deallocate ( std::vector< FinalizedAlloc >  Allocs, OnDeallocatedFunction  OnDeallocated  )

virtual

Deallocate a list of allocation objects.

Dealloc actions will be run in reverse order (from the end of the vector to the start).

Implements llvm::jitlink::JITLinkMemoryManager.

---

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

• include/llvm/ExecutionEngine/JITLink/JITLinkMemoryManager.h
• lib/ExecutionEngine/JITLink/JITLinkMemoryManager.cpp