LLVM API Documentation

llvm::JITMemoryManager Class Reference

#include <JITMemoryManager.h>

Collaboration diagram for llvm::JITMemoryManager:
[legend]

List of all members.

Public Member Functions

 JITMemoryManager ()
virtual ~JITMemoryManager ()
virtual void setMemoryWritable ()=0
virtual void setMemoryExecutable ()=0
virtual void setPoisonMemory (bool poison)=0
virtual void AllocateGOT ()=0
bool isManagingGOT () const
virtual uint8_t * getGOTBase () const =0
virtual void SetDlsymTable (void *ptr)=0
virtual void * getDlsymTable () const =0
bool NeedsExactSize () const
virtual uint8_t * startFunctionBody (const Function *F, uintptr_t &ActualSize)=0
virtual uint8_t * allocateStub (const GlobalValue *F, unsigned StubSize, unsigned Alignment)=0
virtual void endFunctionBody (const Function *F, uint8_t *FunctionStart, uint8_t *FunctionEnd)=0
virtual uint8_t * allocateSpace (intptr_t Size, unsigned Alignment)=0
virtual uint8_t * allocateGlobal (uintptr_t Size, unsigned Alignment)=0
virtual void deallocateMemForFunction (const Function *F)=0
virtual uint8_t * startExceptionTable (const Function *F, uintptr_t &ActualSize)=0
virtual void endExceptionTable (const Function *F, uint8_t *TableStart, uint8_t *TableEnd, uint8_t *FrameRegister)=0
virtual bool CheckInvariants (std::string &ErrorStr)
virtual size_t GetDefaultCodeSlabSize ()
virtual size_t GetDefaultDataSlabSize ()
virtual size_t GetDefaultStubSlabSize ()
virtual unsigned GetNumCodeSlabs ()
virtual unsigned GetNumDataSlabs ()
virtual unsigned GetNumStubSlabs ()

Static Public Member Functions

static JITMemoryManager * CreateDefaultMemManager ()

Protected Attributes

bool HasGOT
bool SizeRequired


Detailed Description

JITMemoryManager - This interface is used by the JIT to allocate and manage memory for the code generated by the JIT. This can be reimplemented by clients that have a strong desire to control how the layout of JIT'd memory works.

Definition at line 29 of file JITMemoryManager.h.


Constructor & Destructor Documentation

llvm::JITMemoryManager::JITMemoryManager (  )  [inline]

Definition at line 35 of file JITMemoryManager.h.

JITMemoryManager::~JITMemoryManager (  )  [virtual]

Definition at line 36 of file JITMemoryManager.cpp.


Member Function Documentation

JITMemoryManager * JITMemoryManager::CreateDefaultMemManager (  )  [static]

CreateDefaultMemManager - This is used to create the default JIT Memory Manager if the client does not provide one to the JIT.

Definition at line 749 of file JITMemoryManager.cpp.

virtual void llvm::JITMemoryManager::setMemoryWritable (  )  [pure virtual]

setMemoryWritable - When code generation is in progress, the code pages may need permissions changed.

virtual void llvm::JITMemoryManager::setMemoryExecutable (  )  [pure virtual]

setMemoryExecutable - When code generation is done and we're ready to start execution, the code pages may need permissions changed.

virtual void llvm::JITMemoryManager::setPoisonMemory ( bool  poison  )  [pure virtual]

setPoisonMemory - Setting this flag to true makes the memory manager garbage values over freed memory. This is useful for testing and debugging, and is be turned on by default in debug mode.

virtual void llvm::JITMemoryManager::AllocateGOT (  )  [pure virtual]

AllocateGOT - If the current table requires a Global Offset Table, this method is invoked to allocate it. This method is required to set HasGOT to true.

bool llvm::JITMemoryManager::isManagingGOT (  )  const [inline]

isManagingGOT - Return true if the AllocateGOT method is called.

Definition at line 66 of file JITMemoryManager.h.

References HasGOT.

virtual uint8_t* llvm::JITMemoryManager::getGOTBase (  )  const [pure virtual]

getGOTBase - If this is managing a Global Offset Table, this method should return a pointer to its base.

virtual void llvm::JITMemoryManager::SetDlsymTable ( void *  ptr  )  [pure virtual]

SetDlsymTable - If the JIT must be able to relocate stubs after they have been emitted, potentially because they are being copied to a process where external symbols live at different addresses than in the JITing process, allocate a table with sufficient information to do so.

virtual void* llvm::JITMemoryManager::getDlsymTable (  )  const [pure virtual]

getDlsymTable - If this is managing a table of entries so that stubs to external symbols can be later relocated, this method should return a pointer to it.

bool llvm::JITMemoryManager::NeedsExactSize (  )  const [inline]

NeedsExactSize - If the memory manager requires to know the size of the objects to be emitted

Definition at line 87 of file JITMemoryManager.h.

References SizeRequired.

virtual uint8_t* llvm::JITMemoryManager::startFunctionBody ( const Function *  F,
uintptr_t &  ActualSize 
) [pure virtual]

startFunctionBody - When we start JITing a function, the JIT calls this method to allocate a block of free RWX memory, which returns a pointer to it. If the JIT wants to request a block of memory of at least a certain size, it passes that value as ActualSize, and this method returns a block with at least that much space. If the JIT doesn't know ahead of time how much space it will need to emit the function, it passes 0 for the ActualSize. In either case, this method is required to pass back the size of the allocated block through ActualSize. The JIT will be careful to not write more than the returned ActualSize bytes of memory.

virtual uint8_t* llvm::JITMemoryManager::allocateStub ( const GlobalValue *  F,
unsigned  StubSize,
unsigned  Alignment 
) [pure virtual]

allocateStub - This method is called by the JIT to allocate space for a function stub (used to handle limited branch displacements) while it is JIT compiling a function. For example, if foo calls bar, and if bar either needs to be lazily compiled or is a native function that exists too far away from the call site to work, this method will be used to make a thunk for it. The stub should be "close" to the current function body, but should not be included in the 'actualsize' returned by startFunctionBody.

virtual void llvm::JITMemoryManager::endFunctionBody ( const Function *  F,
uint8_t *  FunctionStart,
uint8_t *  FunctionEnd 
) [pure virtual]

endFunctionBody - This method is called when the JIT is done codegen'ing the specified function. At this point we know the size of the JIT compiled function. This passes in FunctionStart (which was returned by the startFunctionBody method) and FunctionEnd which is a pointer to the actual end of the function. This method should mark the space allocated and remember where it is in case the client wants to deallocate it.

virtual uint8_t* llvm::JITMemoryManager::allocateSpace ( intptr_t  Size,
unsigned  Alignment 
) [pure virtual]

allocateSpace - Allocate a memory block of the given size. This method cannot be called between calls to startFunctionBody and endFunctionBody.

virtual uint8_t* llvm::JITMemoryManager::allocateGlobal ( uintptr_t  Size,
unsigned  Alignment 
) [pure virtual]

allocateGlobal - Allocate memory for a global.

virtual void llvm::JITMemoryManager::deallocateMemForFunction ( const Function *  F  )  [pure virtual]

deallocateMemForFunction - Free JIT memory for the specified function. This is never called when the JIT is currently emitting a function.

virtual uint8_t* llvm::JITMemoryManager::startExceptionTable ( const Function *  F,
uintptr_t &  ActualSize 
) [pure virtual]

startExceptionTable - When we finished JITing the function, if exception handling is set, we emit the exception table.

virtual void llvm::JITMemoryManager::endExceptionTable ( const Function *  F,
uint8_t *  TableStart,
uint8_t *  TableEnd,
uint8_t *  FrameRegister 
) [pure virtual]

endExceptionTable - This method is called when the JIT is done emitting the exception table.

virtual bool llvm::JITMemoryManager::CheckInvariants ( std::string &  ErrorStr  )  [inline, virtual]

CheckInvariants - For testing only. Return true if all internal invariants are preserved, or return false and set ErrorStr to a helpful error message.

Definition at line 152 of file JITMemoryManager.h.

virtual size_t llvm::JITMemoryManager::GetDefaultCodeSlabSize (  )  [inline, virtual]

GetDefaultCodeSlabSize - For testing only. Returns DefaultCodeSlabSize from DefaultJITMemoryManager.

Definition at line 158 of file JITMemoryManager.h.

virtual size_t llvm::JITMemoryManager::GetDefaultDataSlabSize (  )  [inline, virtual]

GetDefaultDataSlabSize - For testing only. Returns DefaultCodeSlabSize from DefaultJITMemoryManager.

Definition at line 164 of file JITMemoryManager.h.

virtual size_t llvm::JITMemoryManager::GetDefaultStubSlabSize (  )  [inline, virtual]

GetDefaultStubSlabSize - For testing only. Returns DefaultCodeSlabSize from DefaultJITMemoryManager.

Definition at line 170 of file JITMemoryManager.h.

virtual unsigned llvm::JITMemoryManager::GetNumCodeSlabs (  )  [inline, virtual]

GetNumCodeSlabs - For testing only. Returns the number of MemoryBlocks allocated for code.

Definition at line 176 of file JITMemoryManager.h.

virtual unsigned llvm::JITMemoryManager::GetNumDataSlabs (  )  [inline, virtual]

GetNumDataSlabs - For testing only. Returns the number of MemoryBlocks allocated for data.

Definition at line 182 of file JITMemoryManager.h.

virtual unsigned llvm::JITMemoryManager::GetNumStubSlabs (  )  [inline, virtual]

GetNumStubSlabs - For testing only. Returns the number of MemoryBlocks allocated for function stubs.

Definition at line 188 of file JITMemoryManager.h.


Member Data Documentation

Definition at line 31 of file JITMemoryManager.h.

Referenced by isManagingGOT().

Definition at line 32 of file JITMemoryManager.h.

Referenced by NeedsExactSize().


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