Fix several comments which had previously been "the the" where a
[oota-llvm.git] / include / llvm / CodeGen / MachineCodeEmitter.h
1 //===-- llvm/CodeGen/MachineCodeEmitter.h - Code emission -------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
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.).
14 //
15 //===----------------------------------------------------------------------===//
16
17 #ifndef LLVM_CODEGEN_MACHINECODEEMITTER_H
18 #define LLVM_CODEGEN_MACHINECODEEMITTER_H
19
20 #include "llvm/System/DataTypes.h"
21 #include "llvm/Support/DebugLoc.h"
22
23 namespace llvm {
24
25 class MachineBasicBlock;
26 class MachineConstantPool;
27 class MachineJumpTableInfo;
28 class MachineFunction;
29 class MachineModuleInfo;
30 class MachineRelocation;
31 class Value;
32 class GlobalValue;
33 class Function;
34
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.
38 ///
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.
49 /// 
50 class MachineCodeEmitter {
51 protected:
52   /// BufferBegin/BufferEnd - Pointers to the start and end of the memory
53   /// allocated for this code buffer.
54   uint8_t *BufferBegin, *BufferEnd;
55   /// CurBufferPtr - Pointer to the next byte of memory to fill when emitting
56   /// code.  This is guranteed to be in the range [BufferBegin,BufferEnd].  If
57   /// this pointer is at BufferEnd, it will never move due to code emission, and
58   /// all code emission requests will be ignored (this is the buffer overflow
59   /// condition).
60   uint8_t *CurBufferPtr;
61
62 public:
63   virtual ~MachineCodeEmitter() {}
64
65   /// startFunction - This callback is invoked when the specified function is
66   /// about to be code generated.  This initializes the BufferBegin/End/Ptr
67   /// fields.
68   ///
69   virtual void startFunction(MachineFunction &F) = 0;
70
71   /// finishFunction - This callback is invoked when the specified function has
72   /// finished code generation.  If a buffer overflow has occurred, this method
73   /// returns true (the callee is required to try again), otherwise it returns
74   /// false.
75   ///
76   virtual bool finishFunction(MachineFunction &F) = 0;
77
78   /// emitByte - This callback is invoked when a byte needs to be written to the
79   /// output stream.
80   ///
81   void emitByte(uint8_t B) {
82     if (CurBufferPtr != BufferEnd)
83       *CurBufferPtr++ = B;
84   }
85
86   /// emitWordLE - This callback is invoked when a 32-bit word needs to be
87   /// written to the output stream in little-endian format.
88   ///
89   void emitWordLE(uint32_t W) {
90     if (4 <= BufferEnd-CurBufferPtr) {
91       emitWordLEInto(CurBufferPtr, W);
92     } else {
93       CurBufferPtr = BufferEnd;
94     }
95   }
96
97   /// emitWordLEInto - This callback is invoked when a 32-bit word needs to be
98   /// written to an arbitrary buffer in little-endian format.  Buf must have at
99   /// least 4 bytes of available space.
100   ///
101   static void emitWordLEInto(uint8_t *&Buf, uint32_t W) {
102     *Buf++ = (uint8_t)(W >>  0);
103     *Buf++ = (uint8_t)(W >>  8);
104     *Buf++ = (uint8_t)(W >> 16);
105     *Buf++ = (uint8_t)(W >> 24);
106   }
107
108   /// emitWordBE - This callback is invoked when a 32-bit word needs to be
109   /// written to the output stream in big-endian format.
110   ///
111   void emitWordBE(uint32_t W) {
112     if (4 <= BufferEnd-CurBufferPtr) {
113       *CurBufferPtr++ = (uint8_t)(W >> 24);
114       *CurBufferPtr++ = (uint8_t)(W >> 16);
115       *CurBufferPtr++ = (uint8_t)(W >>  8);
116       *CurBufferPtr++ = (uint8_t)(W >>  0);
117     } else {
118       CurBufferPtr = BufferEnd;
119     }
120   }
121
122   /// emitDWordLE - This callback is invoked when a 64-bit word needs to be
123   /// written to the output stream in little-endian format.
124   ///
125   void emitDWordLE(uint64_t W) {
126     if (8 <= BufferEnd-CurBufferPtr) {
127       *CurBufferPtr++ = (uint8_t)(W >>  0);
128       *CurBufferPtr++ = (uint8_t)(W >>  8);
129       *CurBufferPtr++ = (uint8_t)(W >> 16);
130       *CurBufferPtr++ = (uint8_t)(W >> 24);
131       *CurBufferPtr++ = (uint8_t)(W >> 32);
132       *CurBufferPtr++ = (uint8_t)(W >> 40);
133       *CurBufferPtr++ = (uint8_t)(W >> 48);
134       *CurBufferPtr++ = (uint8_t)(W >> 56);
135     } else {
136       CurBufferPtr = BufferEnd;
137     }
138   }
139   
140   /// emitDWordBE - This callback is invoked when a 64-bit word needs to be
141   /// written to the output stream in big-endian format.
142   ///
143   void emitDWordBE(uint64_t W) {
144     if (8 <= BufferEnd-CurBufferPtr) {
145       *CurBufferPtr++ = (uint8_t)(W >> 56);
146       *CurBufferPtr++ = (uint8_t)(W >> 48);
147       *CurBufferPtr++ = (uint8_t)(W >> 40);
148       *CurBufferPtr++ = (uint8_t)(W >> 32);
149       *CurBufferPtr++ = (uint8_t)(W >> 24);
150       *CurBufferPtr++ = (uint8_t)(W >> 16);
151       *CurBufferPtr++ = (uint8_t)(W >>  8);
152       *CurBufferPtr++ = (uint8_t)(W >>  0);
153     } else {
154       CurBufferPtr = BufferEnd;
155     }
156   }
157
158   /// emitAlignment - Move the CurBufferPtr pointer up to the specified
159   /// alignment (saturated to BufferEnd of course).
160   void emitAlignment(unsigned Alignment) {
161     if (Alignment == 0) Alignment = 1;
162
163     if(Alignment <= (uintptr_t)(BufferEnd-CurBufferPtr)) {
164       // Move the current buffer ptr up to the specified alignment.
165       CurBufferPtr =
166         (uint8_t*)(((uintptr_t)CurBufferPtr+Alignment-1) &
167                    ~(uintptr_t)(Alignment-1));
168     } else {
169       CurBufferPtr = BufferEnd;
170     }
171   }
172   
173
174   /// emitULEB128Bytes - This callback is invoked when a ULEB128 needs to be
175   /// written to the output stream.
176   void emitULEB128Bytes(uint64_t Value) {
177     do {
178       uint8_t Byte = Value & 0x7f;
179       Value >>= 7;
180       if (Value) Byte |= 0x80;
181       emitByte(Byte);
182     } while (Value);
183   }
184   
185   /// emitSLEB128Bytes - This callback is invoked when a SLEB128 needs to be
186   /// written to the output stream.
187   void emitSLEB128Bytes(uint64_t Value) {
188     uint64_t Sign = Value >> (8 * sizeof(Value) - 1);
189     bool IsMore;
190   
191     do {
192       uint8_t Byte = Value & 0x7f;
193       Value >>= 7;
194       IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
195       if (IsMore) Byte |= 0x80;
196       emitByte(Byte);
197     } while (IsMore);
198   }
199
200   /// emitString - This callback is invoked when a String needs to be
201   /// written to the output stream.
202   void emitString(const std::string &String) {
203     for (unsigned i = 0, N = static_cast<unsigned>(String.size());
204          i < N; ++i) {
205       uint8_t C = String[i];
206       emitByte(C);
207     }
208     emitByte(0);
209   }
210   
211   /// emitInt32 - Emit a int32 directive.
212   void emitInt32(int32_t Value) {
213     if (4 <= BufferEnd-CurBufferPtr) {
214       *((uint32_t*)CurBufferPtr) = Value;
215       CurBufferPtr += 4;
216     } else {
217       CurBufferPtr = BufferEnd;
218     }
219   }
220
221   /// emitInt64 - Emit a int64 directive.
222   void emitInt64(uint64_t Value) {
223     if (8 <= BufferEnd-CurBufferPtr) {
224       *((uint64_t*)CurBufferPtr) = Value;
225       CurBufferPtr += 8;
226     } else {
227       CurBufferPtr = BufferEnd;
228     }
229   }
230   
231   /// emitInt32At - Emit the Int32 Value in Addr.
232   void emitInt32At(uintptr_t *Addr, uintptr_t Value) {
233     if (Addr >= (uintptr_t*)BufferBegin && Addr < (uintptr_t*)BufferEnd)
234       (*(uint32_t*)Addr) = (uint32_t)Value;
235   }
236   
237   /// emitInt64At - Emit the Int64 Value in Addr.
238   void emitInt64At(uintptr_t *Addr, uintptr_t Value) {
239     if (Addr >= (uintptr_t*)BufferBegin && Addr < (uintptr_t*)BufferEnd)
240       (*(uint64_t*)Addr) = (uint64_t)Value;
241   }
242   
243   /// processDebugLoc - Records debug location information about a
244   /// MachineInstruction.  This is called before emitting any bytes associated
245   /// with the instruction.  Even if successive instructions have the same debug
246   /// location, this method will be called for each one.
247   virtual void processDebugLoc(DebugLoc DL, bool BeforePrintintInsn) {}
248
249   /// emitLabel - Emits a label
250   virtual void emitLabel(uint64_t LabelID) = 0;
251
252   /// allocateSpace - Allocate a block of space in the current output buffer,
253   /// returning null (and setting conditions to indicate buffer overflow) on
254   /// failure.  Alignment is the alignment in bytes of the buffer desired.
255   virtual void *allocateSpace(uintptr_t Size, unsigned Alignment) {
256     emitAlignment(Alignment);
257     void *Result;
258     
259     // Check for buffer overflow.
260     if (Size >= (uintptr_t)(BufferEnd-CurBufferPtr)) {
261       CurBufferPtr = BufferEnd;
262       Result = 0;
263     } else {
264       // Allocate the space.
265       Result = CurBufferPtr;
266       CurBufferPtr += Size;
267     }
268     
269     return Result;
270   }
271
272   /// StartMachineBasicBlock - This should be called by the target when a new
273   /// basic block is about to be emitted.  This way the MCE knows where the
274   /// start of the block is, and can implement getMachineBasicBlockAddress.
275   virtual void StartMachineBasicBlock(MachineBasicBlock *MBB) = 0;
276   
277   /// getCurrentPCValue - This returns the address that the next emitted byte
278   /// will be output to.
279   ///
280   virtual uintptr_t getCurrentPCValue() const {
281     return (uintptr_t)CurBufferPtr;
282   }
283
284   /// getCurrentPCOffset - Return the offset from the start of the emitted
285   /// buffer that we are currently writing to.
286   virtual uintptr_t getCurrentPCOffset() const {
287     return CurBufferPtr-BufferBegin;
288   }
289
290   /// earlyResolveAddresses - True if the code emitter can use symbol addresses 
291   /// during code emission time. The JIT is capable of doing this because it
292   /// creates jump tables or constant pools in memory on the fly while the
293   /// object code emitters rely on a linker to have real addresses and should
294   /// use relocations instead.
295   virtual bool earlyResolveAddresses() const = 0;
296
297   /// addRelocation - Whenever a relocatable address is needed, it should be
298   /// noted with this interface.
299   virtual void addRelocation(const MachineRelocation &MR) = 0;
300   
301   /// FIXME: These should all be handled with relocations!
302   
303   /// getConstantPoolEntryAddress - Return the address of the 'Index' entry in
304   /// the constant pool that was last emitted with the emitConstantPool method.
305   ///
306   virtual uintptr_t getConstantPoolEntryAddress(unsigned Index) const = 0;
307
308   /// getJumpTableEntryAddress - Return the address of the jump table with index
309   /// 'Index' in the function that last called initJumpTableInfo.
310   ///
311   virtual uintptr_t getJumpTableEntryAddress(unsigned Index) const = 0;
312   
313   /// getMachineBasicBlockAddress - Return the address of the specified
314   /// MachineBasicBlock, only usable after the label for the MBB has been
315   /// emitted.
316   ///
317   virtual uintptr_t getMachineBasicBlockAddress(MachineBasicBlock *MBB) const= 0;
318
319   /// getLabelAddress - Return the address of the specified LabelID, only usable
320   /// after the LabelID has been emitted.
321   ///
322   virtual uintptr_t getLabelAddress(uint64_t LabelID) const = 0;
323   
324   /// Specifies the MachineModuleInfo object. This is used for exception handling
325   /// purposes.
326   virtual void setModuleInfo(MachineModuleInfo* Info) = 0;
327 };
328
329 } // End llvm namespace
330
331 #endif