LLVM: llvm::RuntimeDyld::MemoryManager Class Reference (original) (raw)

Memory Management. More...

#include "[llvm/ExecutionEngine/RuntimeDyld.h](RuntimeDyld%5F8h%5Fsource.html)"

Public Member Functions
MemoryManager ()=default
virtual ~MemoryManager ()=default
virtual uint8_t * allocateCodeSection (uintptr_t Size, unsigned Alignment, unsigned SectionID, StringRef SectionName)=0
Allocate a memory block of (at least) the given size suitable for executable code.
virtual uint8_t * allocateDataSection (uintptr_t Size, unsigned Alignment, unsigned SectionID, StringRef SectionName, bool IsReadOnly)=0
Allocate a memory block of (at least) the given size suitable for data.
virtual TLSSection allocateTLSSection (uintptr_t Size, unsigned Alignment, unsigned SectionID, StringRef SectionName)
Allocate a memory block of (at least) the given size to be used for thread-local storage (TLS).
virtual void reserveAllocationSpace (uintptr_t CodeSize, Align CodeAlign, uintptr_t RODataSize, Align RODataAlign, uintptr_t RWDataSize, Align RWDataAlign)
Inform the memory manager about the total amount of memory required to allocate all sections to be loaded: CodeSize - the total size of all code sections DataSizeRO - the total size of all read-only data sections DataSizeRW - the total size of all read-write data sections.
virtual bool needsToReserveAllocationSpace ()
Override to return true to enable the reserveAllocationSpace callback.
virtual bool allowStubAllocation () const
Override to return false to tell LLVM no stub space will be needed.
virtual void registerEHFrames (uint8_t *Addr, uint64_t LoadAddr, size_t Size)=0
Register the EH frames with the runtime so that c++ exceptions work.
virtual void deregisterEHFrames ()=0
virtual bool finalizeMemory (std::string *ErrMsg=nullptr)=0
This method is called when object loading is complete and section page permissions can be applied.
virtual void notifyObjectLoaded (RuntimeDyld &RTDyld, const object::ObjectFile &Obj)
This method is called after an object has been loaded into memory but before relocations are applied to the loaded sections.
Friends
class RuntimeDyld

Memory Management.

Definition at line 93 of file RuntimeDyld.h.

llvm::RuntimeDyld::MemoryManager::MemoryManager ( ) default

◆ ~MemoryManager()

virtual llvm::RuntimeDyld::MemoryManager::~MemoryManager ( ) virtualdefault

◆ allocateCodeSection()

virtual uint8_t * llvm::RuntimeDyld::MemoryManager::allocateCodeSection ( uintptr_t Size, unsigned Alignment, unsigned SectionID, StringRef SectionName ) pure virtual

◆ allocateDataSection()

virtual uint8_t * llvm::RuntimeDyld::MemoryManager::allocateDataSection ( uintptr_t Size, unsigned Alignment, unsigned SectionID, StringRef SectionName, bool IsReadOnly ) pure virtual

◆ allocateTLSSection()

◆ allowStubAllocation()

virtual bool llvm::RuntimeDyld::MemoryManager::allowStubAllocation ( ) const inlinevirtual

Override to return false to tell LLVM no stub space will be needed.

This requires some guarantees depending on architecuture, but when you know what you are doing it saves allocated space.

Definition at line 149 of file RuntimeDyld.h.

◆ deregisterEHFrames()

virtual void llvm::RuntimeDyld::MemoryManager::deregisterEHFrames ( ) pure virtual

◆ finalizeMemory()

virtual bool llvm::RuntimeDyld::MemoryManager::finalizeMemory ( std::string * ErrMsg = nullptr) pure virtual

This method is called when object loading is complete and section page permissions can be applied.

It is up to the memory manager implementation to decide whether or not to act on this method. The memory manager will typically allocate all sections as read-write and then apply specific permissions when this method is called. Code sections cannot be executed until this function has been called. In addition, any cache coherency operations needed to reliably use the memory are also performed.

Returns true if an error occurred, false otherwise.

Implemented in llvm::orc::EPCGenericRTDyldMemoryManager, and llvm::SectionMemoryManager.

Referenced by LLVMOrcCreateRTDyldObjectLinkingLayerWithMCJITMemoryManagerLikeCallbacks().

◆ needsToReserveAllocationSpace()

virtual bool llvm::RuntimeDyld::MemoryManager::needsToReserveAllocationSpace ( ) inlinevirtual

◆ notifyObjectLoaded()

◆ registerEHFrames()

virtual void llvm::RuntimeDyld::MemoryManager::registerEHFrames ( uint8_t * Addr, uint64_t LoadAddr, size_t Size ) pure virtual

Register the EH frames with the runtime so that c++ exceptions work.

Addr parameter provides the local address of the EH frame section data, while LoadAddr provides the address of the data in the target address space. If the section has not been remapped (which will usually be the case for local execution) these two values will be the same.

Implemented in llvm::orc::EPCGenericRTDyldMemoryManager, and llvm::RTDyldMemoryManager.

References Size.

◆ reserveAllocationSpace()

virtual void llvm::RuntimeDyld::MemoryManager::reserveAllocationSpace ( uintptr_t CodeSize, Align CodeAlign, uintptr_t RODataSize, Align RODataAlign, uintptr_t RWDataSize, Align RWDataAlign ) inlinevirtual

Inform the memory manager about the total amount of memory required to allocate all sections to be loaded: CodeSize - the total size of all code sections DataSizeRO - the total size of all read-only data sections DataSizeRW - the total size of all read-write data sections.

Note that by default the callback is disabled. To enable it redefine the method needsToReserveAllocationSpace to return true.

Reimplemented in llvm::orc::EPCGenericRTDyldMemoryManager.

Definition at line 138 of file RuntimeDyld.h.

References CodeSize.

◆ RuntimeDyld

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