LLVM API Documentation
#include <JITCodeEmitter.h>
Public Member Functions | |
| virtual | ~JITCodeEmitter () |
| virtual void | startFunction (MachineFunction &F)=0 |
| virtual bool | finishFunction (MachineFunction &F)=0 |
| virtual void | startGVStub (const GlobalValue *GV, unsigned StubSize, unsigned Alignment=1)=0 |
| virtual void | startGVStub (const GlobalValue *GV, void *Buffer, unsigned StubSize)=0 |
| virtual void * | finishGVStub (const GlobalValue *F)=0 |
| void | emitByte (uint8_t B) |
| void | emitWordLE (uint32_t W) |
| void | emitWordBE (uint32_t W) |
| void | emitDWordLE (uint64_t W) |
| void | emitDWordBE (uint64_t W) |
| void | emitAlignment (unsigned Alignment) |
| void | emitAlignmentWithFill (unsigned Alignment, uint8_t Fill) |
| void | emitULEB128Bytes (uint64_t Value) |
| void | emitSLEB128Bytes (int64_t Value) |
| void | emitString (const std::string &String) |
| void | emitInt32 (uint32_t Value) |
| emitInt32 - Emit a int32 directive. | |
| void | emitInt64 (uint64_t Value) |
| emitInt64 - Emit a int64 directive. | |
| void | emitInt32At (uintptr_t *Addr, uintptr_t Value) |
| emitInt32At - Emit the Int32 Value in Addr. | |
| void | emitInt64At (uintptr_t *Addr, uintptr_t Value) |
| emitInt64At - Emit the Int64 Value in Addr. | |
| virtual void | emitLabel (uint64_t LabelID)=0 |
| emitLabel - Emits a label | |
| virtual void * | allocateSpace (uintptr_t Size, unsigned Alignment) |
| virtual void * | allocateGlobal (uintptr_t Size, unsigned Alignment)=0 |
| virtual void | StartMachineBasicBlock (MachineBasicBlock *MBB)=0 |
| virtual uintptr_t | getCurrentPCValue () const |
| uintptr_t | getCurrentPCOffset () const |
| bool | earlyResolveAddresses () const |
| virtual void | addRelocation (const MachineRelocation &MR)=0 |
| virtual uintptr_t | getConstantPoolEntryAddress (unsigned Index) const =0 |
| FIXME: These should all be handled with relocations! | |
| virtual uintptr_t | getJumpTableEntryAddress (unsigned Index) const =0 |
| virtual uintptr_t | getMachineBasicBlockAddress (MachineBasicBlock *MBB) const =0 |
| virtual uintptr_t | getLabelAddress (uint64_t LabelID) const =0 |
| virtual void | setModuleInfo (MachineModuleInfo *Info)=0 |
Emission of machine code is complicated by the fact that we don't (in general) know the size of the machine code that we're about to emit before we emit it. As such, we preallocate a certain amount of memory, and set the BufferBegin/BufferEnd pointers to the start and end of the buffer. As we emit machine instructions, we advance the CurBufferPtr to indicate the location of the next byte to emit. In the case of a buffer overflow (we need to emit more machine code than we have allocated space for), the CurBufferPtr will saturate to BufferEnd and ignore stores. Once the entire function has been emitted, the overflow condition is checked, and if it has occurred, more memory is allocated, and we reemit the code into it.
Definition at line 54 of file JITCodeEmitter.h.
| virtual llvm::JITCodeEmitter::~JITCodeEmitter | ( | ) | [inline, virtual] |
Definition at line 56 of file JITCodeEmitter.h.
| virtual void llvm::JITCodeEmitter::startFunction | ( | MachineFunction & | F | ) | [pure virtual] |
startFunction - This callback is invoked when the specified function is about to be code generated. This initializes the BufferBegin/End/Ptr fields.
Implements llvm::MachineCodeEmitter.
| virtual bool llvm::JITCodeEmitter::finishFunction | ( | MachineFunction & | F | ) | [pure virtual] |
finishFunction - This callback is invoked when the specified function has finished code generation. If a buffer overflow has occurred, this method returns true (the callee is required to try again), otherwise it returns false.
Implements llvm::MachineCodeEmitter.
| virtual void llvm::JITCodeEmitter::startGVStub | ( | const GlobalValue * | GV, | |
| unsigned | StubSize, | |||
| unsigned | Alignment = 1 | |||
| ) | [pure virtual] |
startGVStub - This callback is invoked when the JIT needs the address of a GV (e.g. function) that has not been code generated yet. The StubSize specifies the total size required by the stub.
Referenced by llvm::X86JITInfo::emitFunctionStub(), llvm::PPCJITInfo::emitFunctionStub(), llvm::AlphaJITInfo::emitFunctionStub(), llvm::ARMJITInfo::emitFunctionStub(), llvm::X86JITInfo::emitFunctionStubAtAddr(), llvm::ARMJITInfo::emitGlobalValueIndirectSym(), and llvm::X86JITInfo::emitGlobalValueIndirectSym().
| virtual void llvm::JITCodeEmitter::startGVStub | ( | const GlobalValue * | GV, | |
| void * | Buffer, | |||
| unsigned | StubSize | |||
| ) | [pure virtual] |
startGVStub - This callback is invoked when the JIT needs the address of a GV (e.g. function) that has not been code generated yet. Buffer points to memory already allocated for this stub.
| virtual void* llvm::JITCodeEmitter::finishGVStub | ( | const GlobalValue * | F | ) | [pure virtual] |
finishGVStub - This callback is invoked to terminate a GV stub.
Referenced by llvm::X86JITInfo::emitFunctionStub(), llvm::PPCJITInfo::emitFunctionStub(), llvm::ARMJITInfo::emitFunctionStub(), llvm::AlphaJITInfo::emitFunctionStub(), llvm::X86JITInfo::emitFunctionStubAtAddr(), llvm::X86JITInfo::emitGlobalValueIndirectSym(), and llvm::ARMJITInfo::emitGlobalValueIndirectSym().
| void llvm::JITCodeEmitter::emitByte | ( | uint8_t | B | ) | [inline] |
emitByte - This callback is invoked when a byte needs to be written to the output stream.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 92 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferEnd, and llvm::MachineCodeEmitter::CurBufferPtr.
Referenced by llvm::X86JITInfo::emitFunctionStub(), llvm::X86JITInfo::emitFunctionStubAtAddr(), emitSLEB128Bytes(), emitString(), and emitULEB128Bytes().
| void llvm::JITCodeEmitter::emitWordLE | ( | uint32_t | W | ) | [inline] |
emitWordLE - This callback is invoked when a 32-bit word needs to be written to the output stream in little-endian format.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 100 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferEnd, and llvm::MachineCodeEmitter::CurBufferPtr.
Referenced by llvm::X86JITInfo::emitFunctionStub(), llvm::ARMJITInfo::emitFunctionStub(), llvm::AlphaJITInfo::emitFunctionStub(), llvm::X86JITInfo::emitFunctionStubAtAddr(), llvm::X86JITInfo::emitGlobalValueIndirectSym(), and llvm::ARMJITInfo::emitGlobalValueIndirectSym().
| void llvm::JITCodeEmitter::emitWordBE | ( | uint32_t | W | ) | [inline] |
emitWordBE - This callback is invoked when a 32-bit word needs to be written to the output stream in big-endian format.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 114 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferEnd, and llvm::MachineCodeEmitter::CurBufferPtr.
Referenced by llvm::PPCJITInfo::emitFunctionStub().
| void llvm::JITCodeEmitter::emitDWordLE | ( | uint64_t | W | ) | [inline] |
emitDWordLE - This callback is invoked when a 64-bit word needs to be written to the output stream in little-endian format.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 128 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferEnd, and llvm::MachineCodeEmitter::CurBufferPtr.
| void llvm::JITCodeEmitter::emitDWordBE | ( | uint64_t | W | ) | [inline] |
emitDWordBE - This callback is invoked when a 64-bit word needs to be written to the output stream in big-endian format.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 146 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferEnd, and llvm::MachineCodeEmitter::CurBufferPtr.
| void llvm::JITCodeEmitter::emitAlignment | ( | unsigned | Alignment | ) | [inline] |
emitAlignment - Move the CurBufferPtr pointer up the the specified alignment (saturated to BufferEnd of course).
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 163 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferEnd, llvm::MachineCodeEmitter::CurBufferPtr, and llvm::RoundUpToAlignment().
Referenced by allocateSpace().
| void llvm::JITCodeEmitter::emitAlignmentWithFill | ( | unsigned | Alignment, | |
| uint8_t | Fill | |||
| ) | [inline] |
emitAlignmentWithFill - Similar to emitAlignment, except that the extra bytes are filled with the provided byte.
Definition at line 172 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferEnd, llvm::MachineCodeEmitter::CurBufferPtr, and llvm::RoundUpToAlignment().
| void llvm::JITCodeEmitter::emitULEB128Bytes | ( | uint64_t | Value | ) | [inline] |
emitULEB128Bytes - This callback is invoked when a ULEB128 needs to be written to the output stream.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 188 of file JITCodeEmitter.h.
References emitByte().
| void llvm::JITCodeEmitter::emitSLEB128Bytes | ( | int64_t | Value | ) | [inline] |
emitSLEB128Bytes - This callback is invoked when a SLEB128 needs to be written to the output stream.
Definition at line 199 of file JITCodeEmitter.h.
References emitByte().
| void llvm::JITCodeEmitter::emitString | ( | const std::string & | String | ) | [inline] |
emitString - This callback is invoked when a String needs to be written to the output stream.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 214 of file JITCodeEmitter.h.
References llvm::CallingConv::C, and emitByte().
| void llvm::JITCodeEmitter::emitInt32 | ( | uint32_t | Value | ) | [inline] |
emitInt32 - Emit a int32 directive.
Definition at line 224 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferEnd, and llvm::MachineCodeEmitter::CurBufferPtr.
| void llvm::JITCodeEmitter::emitInt64 | ( | uint64_t | Value | ) | [inline] |
emitInt64 - Emit a int64 directive.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 234 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferEnd, and llvm::MachineCodeEmitter::CurBufferPtr.
| void llvm::JITCodeEmitter::emitInt32At | ( | uintptr_t * | Addr, | |
| uintptr_t | Value | |||
| ) | [inline] |
emitInt32At - Emit the Int32 Value in Addr.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 244 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferBegin, and llvm::MachineCodeEmitter::BufferEnd.
| void llvm::JITCodeEmitter::emitInt64At | ( | uintptr_t * | Addr, | |
| uintptr_t | Value | |||
| ) | [inline] |
emitInt64At - Emit the Int64 Value in Addr.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 250 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferBegin, and llvm::MachineCodeEmitter::BufferEnd.
| virtual void llvm::JITCodeEmitter::emitLabel | ( | uint64_t | LabelID | ) | [pure virtual] |
| virtual void* llvm::JITCodeEmitter::allocateSpace | ( | uintptr_t | Size, | |
| unsigned | Alignment | |||
| ) | [inline, virtual] |
allocateSpace - Allocate a block of space in the current output buffer, returning null (and setting conditions to indicate buffer overflow) on failure. Alignment is the alignment in bytes of the buffer desired.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 262 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferEnd, llvm::MachineCodeEmitter::CurBufferPtr, and emitAlignment().
Referenced by llvm::JIT::getMemoryForGV().
| virtual void* llvm::JITCodeEmitter::allocateGlobal | ( | uintptr_t | Size, | |
| unsigned | Alignment | |||
| ) | [pure virtual] |
allocateGlobal - Allocate memory for a global. Unlike allocateSpace, this method does not allocate memory in the current output buffer, because a global may live longer than the current function.
Referenced by llvm::JIT::getMemoryForGV().
| virtual void llvm::JITCodeEmitter::StartMachineBasicBlock | ( | MachineBasicBlock * | MBB | ) | [pure virtual] |
StartMachineBasicBlock - This should be called by the target when a new basic block is about to be emitted. This way the MCE knows where the start of the block is, and can implement getMachineBasicBlockAddress.
Implements llvm::MachineCodeEmitter.
| virtual uintptr_t llvm::JITCodeEmitter::getCurrentPCValue | ( | ) | const [inline, virtual] |
getCurrentPCValue - This returns the address that the next emitted byte will be output to.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 292 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::CurBufferPtr.
Referenced by llvm::X86JITInfo::emitFunctionStub(), llvm::PPCJITInfo::emitFunctionStub(), llvm::ARMJITInfo::emitFunctionStub(), llvm::AlphaJITInfo::emitFunctionStub(), llvm::X86JITInfo::emitFunctionStubAtAddr(), and llvm::ARMJITInfo::emitGlobalValueIndirectSym().
| uintptr_t llvm::JITCodeEmitter::getCurrentPCOffset | ( | ) | const [inline, virtual] |
getCurrentPCOffset - Return the offset from the start of the emitted buffer that we are currently writing to.
Reimplemented from llvm::MachineCodeEmitter.
Definition at line 298 of file JITCodeEmitter.h.
References llvm::MachineCodeEmitter::BufferBegin, and llvm::MachineCodeEmitter::CurBufferPtr.
| bool llvm::JITCodeEmitter::earlyResolveAddresses | ( | ) | const [inline, virtual] |
earlyResolveAddresses - True if the code emitter can use symbol addresses during code emission time. The JIT is capable of doing this because it creates jump tables or constant pools in memory on the fly while the object code emitters rely on a linker to have real addresses and should use relocations instead.
Implements llvm::MachineCodeEmitter.
Definition at line 307 of file JITCodeEmitter.h.
| virtual void llvm::JITCodeEmitter::addRelocation | ( | const MachineRelocation & | MR | ) | [pure virtual] |
addRelocation - Whenever a relocatable address is needed, it should be noted with this interface.
Implements llvm::MachineCodeEmitter.
| virtual uintptr_t llvm::JITCodeEmitter::getConstantPoolEntryAddress | ( | unsigned | Index | ) | const [pure virtual] |
FIXME: These should all be handled with relocations!
getConstantPoolEntryAddress - Return the address of the 'Index' entry in the constant pool that was last emitted with the emitConstantPool method.
Implements llvm::MachineCodeEmitter.
| virtual uintptr_t llvm::JITCodeEmitter::getJumpTableEntryAddress | ( | unsigned | Index | ) | const [pure virtual] |
getJumpTableEntryAddress - Return the address of the jump table with index 'Index' in the function that last called initJumpTableInfo.
Implements llvm::MachineCodeEmitter.
| virtual uintptr_t llvm::JITCodeEmitter::getMachineBasicBlockAddress | ( | MachineBasicBlock * | MBB | ) | const [pure virtual] |
getMachineBasicBlockAddress - Return the address of the specified MachineBasicBlock, only usable after the label for the MBB has been emitted.
Implements llvm::MachineCodeEmitter.
| virtual uintptr_t llvm::JITCodeEmitter::getLabelAddress | ( | uint64_t | LabelID | ) | const [pure virtual] |
getLabelAddress - Return the address of the specified LabelID, only usable after the LabelID has been emitted.
Implements llvm::MachineCodeEmitter.
| virtual void llvm::JITCodeEmitter::setModuleInfo | ( | MachineModuleInfo * | Info | ) | [pure virtual] |
Specifies the MachineModuleInfo object. This is used for exception handling purposes.
Implements llvm::MachineCodeEmitter.