1 //===-- llvm/CodeGen/MachineCodeEmitter.h - Code emission -------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines an abstract interface that is used by the machine code
11 // emission framework to output the code. This allows machine code emission to
12 // be separated from concerns such as resolution of call targets, and where the
13 // machine code will be written (memory or disk, f.e.).
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_CODEGEN_MACHINECODEEMITTER_H
18 #define LLVM_CODEGEN_MACHINECODEEMITTER_H
20 #include "llvm/Support/DataTypes.h"
25 class MachineBasicBlock;
26 class MachineConstantPool;
27 class MachineJumpTableInfo;
28 class MachineFunction;
29 class MachineModuleInfo;
30 class MachineRelocation;
35 /// MachineCodeEmitter - This class defines two sorts of methods: those for
36 /// emitting the actual bytes of machine code, and those for emitting auxillary
37 /// structures, such as jump tables, relocations, etc.
39 /// Emission of machine code is complicated by the fact that we don't (in
40 /// general) know the size of the machine code that we're about to emit before
41 /// we emit it. As such, we preallocate a certain amount of memory, and set the
42 /// BufferBegin/BufferEnd pointers to the start and end of the buffer. As we
43 /// emit machine instructions, we advance the CurBufferPtr to indicate the
44 /// location of the next byte to emit. In the case of a buffer overflow (we
45 /// need to emit more machine code than we have allocated space for), the
46 /// CurBufferPtr will saturate to BufferEnd and ignore stores. Once the entire
47 /// function has been emitted, the overflow condition is checked, and if it has
48 /// occurred, more memory is allocated, and we reemit the code into it.
50 class MachineCodeEmitter {
52 /// BufferBegin/BufferEnd - Pointers to the start and end of the memory
53 /// allocated for this code buffer.
54 unsigned char *BufferBegin, *BufferEnd;
56 /// CurBufferPtr - Pointer to the next byte of memory to fill when emitting
57 /// code. This is guranteed to be in the range [BufferBegin,BufferEnd]. If
58 /// this pointer is at BufferEnd, it will never move due to code emission, and
59 /// all code emission requests will be ignored (this is the buffer overflow
61 unsigned char *CurBufferPtr;
64 virtual ~MachineCodeEmitter() {}
66 /// startFunction - This callback is invoked when the specified function is
67 /// about to be code generated. This initializes the BufferBegin/End/Ptr
70 virtual void startFunction(MachineFunction &F) = 0;
72 /// finishFunction - This callback is invoked when the specified function has
73 /// finished code generation. If a buffer overflow has occurred, this method
74 /// returns true (the callee is required to try again), otherwise it returns
77 virtual bool finishFunction(MachineFunction &F) = 0;
79 /// startFunctionStub - This callback is invoked when the JIT needs the
80 /// address of a function that has not been code generated yet. The StubSize
81 /// specifies the total size required by the stub. Stubs are not allowed to
82 /// have constant pools, the can only use the other emitByte*/emitWord*
85 virtual void startFunctionStub(const GlobalValue* F, unsigned StubSize,
86 unsigned Alignment = 1) = 0;
88 /// finishFunctionStub - This callback is invoked to terminate a function
91 virtual void *finishFunctionStub(const GlobalValue* F) = 0;
93 /// emitByte - This callback is invoked when a byte needs to be written to the
96 void emitByte(unsigned char B) {
97 if (CurBufferPtr != BufferEnd)
101 /// emitWordLE - This callback is invoked when a 32-bit word needs to be
102 /// written to the output stream in little-endian format.
104 void emitWordLE(unsigned W) {
105 if (CurBufferPtr+4 <= BufferEnd) {
106 *CurBufferPtr++ = (unsigned char)(W >> 0);
107 *CurBufferPtr++ = (unsigned char)(W >> 8);
108 *CurBufferPtr++ = (unsigned char)(W >> 16);
109 *CurBufferPtr++ = (unsigned char)(W >> 24);
111 CurBufferPtr = BufferEnd;
115 /// emitWordBE - This callback is invoked when a 32-bit word needs to be
116 /// written to the output stream in big-endian format.
118 void emitWordBE(unsigned W) {
119 if (CurBufferPtr+4 <= BufferEnd) {
120 *CurBufferPtr++ = (unsigned char)(W >> 24);
121 *CurBufferPtr++ = (unsigned char)(W >> 16);
122 *CurBufferPtr++ = (unsigned char)(W >> 8);
123 *CurBufferPtr++ = (unsigned char)(W >> 0);
125 CurBufferPtr = BufferEnd;
129 /// emitAlignment - Move the CurBufferPtr pointer up the the specified
130 /// alignment (saturated to BufferEnd of course).
131 void emitAlignment(unsigned Alignment) {
132 if (Alignment == 0) Alignment = 1;
133 // Move the current buffer ptr up to the specified alignment.
135 (unsigned char*)(((intptr_t)CurBufferPtr+Alignment-1) &
136 ~(intptr_t)(Alignment-1));
137 if (CurBufferPtr > BufferEnd)
138 CurBufferPtr = BufferEnd;
142 /// emitULEB128Bytes - This callback is invoked when a ULEB128 needs to be
143 /// written to the output stream.
144 void emitULEB128Bytes(unsigned Value) {
146 unsigned char Byte = Value & 0x7f;
148 if (Value) Byte |= 0x80;
153 /// emitSLEB128Bytes - This callback is invoked when a SLEB128 needs to be
154 /// written to the output stream.
155 void emitSLEB128Bytes(int Value) {
156 int Sign = Value >> (8 * sizeof(Value) - 1);
160 unsigned char Byte = Value & 0x7f;
162 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
163 if (IsMore) Byte |= 0x80;
168 /// emitString - This callback is invoked when a String needs to be
169 /// written to the output stream.
170 void emitString(const std::string &String) {
171 for (unsigned i = 0, N = static_cast<unsigned>(String.size());
173 unsigned char C = String[i];
179 /// emitInt32 - Emit a int32 directive.
180 void emitInt32(int Value) {
181 if (CurBufferPtr+4 <= BufferEnd) {
182 *((uint32_t*)CurBufferPtr) = Value;
185 CurBufferPtr = BufferEnd;
189 /// emitInt64 - Emit a int64 directive.
190 void emitInt64(uint64_t Value) {
191 if (CurBufferPtr+8 <= BufferEnd) {
192 *((uint64_t*)CurBufferPtr) = Value;
195 CurBufferPtr = BufferEnd;
199 /// emitAt - Emit Value in Addr
200 void emitAt(uintptr_t *Addr, uintptr_t Value) {
201 if (Addr >= (uintptr_t*)BufferBegin && Addr < (uintptr_t*)BufferEnd)
205 /// emitLabel - Emits a label
206 virtual void emitLabel(uint64_t LabelID) = 0;
208 /// allocateSpace - Allocate a block of space in the current output buffer,
209 /// returning null (and setting conditions to indicate buffer overflow) on
210 /// failure. Alignment is the alignment in bytes of the buffer desired.
211 void *allocateSpace(intptr_t Size, unsigned Alignment) {
212 emitAlignment(Alignment);
213 void *Result = CurBufferPtr;
215 // Allocate the space.
216 CurBufferPtr += Size;
218 // Check for buffer overflow.
219 if (CurBufferPtr >= BufferEnd) {
220 CurBufferPtr = BufferEnd;
226 /// StartMachineBasicBlock - This should be called by the target when a new
227 /// basic block is about to be emitted. This way the MCE knows where the
228 /// start of the block is, and can implement getMachineBasicBlockAddress.
229 virtual void StartMachineBasicBlock(MachineBasicBlock *MBB) = 0;
231 /// getCurrentPCValue - This returns the address that the next emitted byte
232 /// will be output to.
234 virtual intptr_t getCurrentPCValue() const {
235 return (intptr_t)CurBufferPtr;
238 /// getCurrentPCOffset - Return the offset from the start of the emitted
239 /// buffer that we are currently writing to.
240 intptr_t getCurrentPCOffset() const {
241 return CurBufferPtr-BufferBegin;
244 /// addRelocation - Whenever a relocatable address is needed, it should be
245 /// noted with this interface.
246 virtual void addRelocation(const MachineRelocation &MR) = 0;
249 /// FIXME: These should all be handled with relocations!
251 /// getConstantPoolEntryAddress - Return the address of the 'Index' entry in
252 /// the constant pool that was last emitted with the emitConstantPool method.
254 virtual intptr_t getConstantPoolEntryAddress(unsigned Index) const = 0;
256 /// getJumpTableEntryAddress - Return the address of the jump table with index
257 /// 'Index' in the function that last called initJumpTableInfo.
259 virtual intptr_t getJumpTableEntryAddress(unsigned Index) const = 0;
261 /// getMachineBasicBlockAddress - Return the address of the specified
262 /// MachineBasicBlock, only usable after the label for the MBB has been
265 virtual intptr_t getMachineBasicBlockAddress(MachineBasicBlock *MBB) const= 0;
267 /// getLabelAddress - Return the address of the specified LabelID, only usable
268 /// after the LabelID has been emitted.
270 virtual intptr_t getLabelAddress(uint64_t LabelID) const = 0;
272 /// Specifies the MachineModuleInfo object. This is used for exception handling
274 virtual void setModuleInfo(MachineModuleInfo* Info) = 0;
277 } // End llvm namespace