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/Support/DataTypes.h"
  21 #include <vector>
  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   unsigned char *BufferBegin, *BufferEnd;
  55
  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
  60   /// condition).
  61   unsigned char *CurBufferPtr;
  62
  63 public:
  64   virtual ~MachineCodeEmitter() {}
  65
  66   /// startFunction - This callback is invoked when the specified function is
  67   /// about to be code generated.  This initializes the BufferBegin/End/Ptr
  68   /// fields.
  69   ///
  70   virtual void startFunction(MachineFunction &F) = 0;
  71
  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
  75   /// false.
  76   ///
  77   virtual bool finishFunction(MachineFunction &F) = 0;
  78
  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*
  83   /// methods.
  84   ///
  85   virtual void startFunctionStub(unsigned StubSize, unsigned Alignment = 1) = 0;
  86
  87   /// finishFunctionStub - This callback is invoked to terminate a function
  88   /// stub.
  89   ///
  90   virtual void *finishFunctionStub(const Function *F) = 0;
  91
  92   /// emitByte - This callback is invoked when a byte needs to be written to the
  93   /// output stream.
  94   ///
  95   void emitByte(unsigned char B) {
  96     if (CurBufferPtr != BufferEnd)
  97       *CurBufferPtr++ = B;
  98   }
  99
 100   /// emitWordLE - This callback is invoked when a 32-bit word needs to be
 101   /// written to the output stream in little-endian format.
 102   ///
 103   void emitWordLE(unsigned W) {
 104     if (CurBufferPtr+4 <= BufferEnd) {
 105       *CurBufferPtr++ = (unsigned char)(W >>  0);
 106       *CurBufferPtr++ = (unsigned char)(W >>  8);
 107       *CurBufferPtr++ = (unsigned char)(W >> 16);
 108       *CurBufferPtr++ = (unsigned char)(W >> 24);
 109     } else {
 110       CurBufferPtr = BufferEnd;
 111     }
 112   }
 113
 114   /// emitWordBE - This callback is invoked when a 32-bit word needs to be
 115   /// written to the output stream in big-endian format.
 116   ///
 117   void emitWordBE(unsigned W) {
 118     if (CurBufferPtr+4 <= BufferEnd) {
 119       *CurBufferPtr++ = (unsigned char)(W >> 24);
 120       *CurBufferPtr++ = (unsigned char)(W >> 16);
 121       *CurBufferPtr++ = (unsigned char)(W >>  8);
 122       *CurBufferPtr++ = (unsigned char)(W >>  0);
 123     } else {
 124       CurBufferPtr = BufferEnd;
 125     }
 126   }
 127
 128   /// emitAlignment - Move the CurBufferPtr pointer up the the specified
 129   /// alignment (saturated to BufferEnd of course).
 130   void emitAlignment(unsigned Alignment) {
 131     if (Alignment == 0) Alignment = 1;
 132     // Move the current buffer ptr up to the specified alignment.
 133     CurBufferPtr =
 134       (unsigned char*)(((intptr_t)CurBufferPtr+Alignment-1) &
 135                        ~(intptr_t)(Alignment-1));
 136     if (CurBufferPtr > BufferEnd)
 137       CurBufferPtr = BufferEnd;
 138   }
 139
 140
 141   /// emitULEB128Bytes - This callback is invoked when a ULEB128 needs to be
 142   /// written to the output stream.
 143   void emitULEB128Bytes(unsigned Value) {
 144     do {
 145       unsigned char Byte = Value & 0x7f;
 146       Value >>= 7;
 147       if (Value) Byte |= 0x80;
 148       emitByte(Byte);
 149     } while (Value);
 150   }
 151
 152   /// emitSLEB128Bytes - This callback is invoked when a SLEB128 needs to be
 153   /// written to the output stream.
 154   void emitSLEB128Bytes(int Value) {
 155     int Sign = Value >> (8 * sizeof(Value) - 1);
 156     bool IsMore;
 157
 158     do {
 159       unsigned char Byte = Value & 0x7f;
 160       Value >>= 7;
 161       IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
 162       if (IsMore) Byte |= 0x80;
 163       emitByte(Byte);
 164     } while (IsMore);
 165   }
 166
 167   /// emitString - This callback is invoked when a String needs to be
 168   /// written to the output stream.
 169   void emitString(const std::string &String) {
 170     for (unsigned i = 0, N = String.size(); i < N; ++i) {
 171       unsigned char C = String[i];
 172       emitByte(C);
 173     }
 174     emitByte(0);
 175   }
 176
 177   /// emitInt32 - Emit a int32 directive.
 178   void emitInt32(int Value) {
 179     if (CurBufferPtr+4 <= BufferEnd) {
 180       *((uint32_t*)CurBufferPtr) = Value;
 181       CurBufferPtr += 4;
 182     } else {
 183       CurBufferPtr = BufferEnd;
 184     }
 185   }
 186
 187   /// emitInt64 - Emit a int64 directive.
 188   void emitInt64(uint64_t Value) {
 189     if (CurBufferPtr+8 <= BufferEnd) {
 190       *((uint64_t*)CurBufferPtr) = Value;
 191       CurBufferPtr += 8;
 192     } else {
 193       CurBufferPtr = BufferEnd;
 194     }
 195   }
 196
 197   /// emitAt - Emit Value in Addr
 198   void emitAt(uintptr_t *Addr, uintptr_t Value) {
 199     if (Addr >= (uintptr_t*)BufferBegin && Addr < (uintptr_t*)BufferEnd)
 200       (*Addr) = Value;
 201   }
 202
 203   /// emitLabel - Emits a label
 204   virtual void emitLabel(uint64_t LabelID) = 0;
 205
 206   /// allocateSpace - Allocate a block of space in the current output buffer,
 207   /// returning null (and setting conditions to indicate buffer overflow) on
 208   /// failure.  Alignment is the alignment in bytes of the buffer desired.
 209   void *allocateSpace(intptr_t Size, unsigned Alignment) {
 210     emitAlignment(Alignment);
 211     void *Result = CurBufferPtr;
 212
 213     // Allocate the space.
 214     CurBufferPtr += Size;
 215
 216     // Check for buffer overflow.
 217     if (CurBufferPtr >= BufferEnd) {
 218       CurBufferPtr = BufferEnd;
 219       Result = 0;
 220     }
 221     return Result;
 222   }
 223
 224   /// StartMachineBasicBlock - This should be called by the target when a new
 225   /// basic block is about to be emitted.  This way the MCE knows where the
 226   /// start of the block is, and can implement getMachineBasicBlockAddress.
 227   virtual void StartMachineBasicBlock(MachineBasicBlock *MBB) = 0;
 228
 229   /// getCurrentPCValue - This returns the address that the next emitted byte
 230   /// will be output to.
 231   ///
 232   virtual intptr_t getCurrentPCValue() const {
 233     return (intptr_t)CurBufferPtr;
 234   }
 235
 236   /// getCurrentPCOffset - Return the offset from the start of the emitted
 237   /// buffer that we are currently writing to.
 238   intptr_t getCurrentPCOffset() const {
 239     return CurBufferPtr-BufferBegin;
 240   }
 241
 242   /// addRelocation - Whenever a relocatable address is needed, it should be
 243   /// noted with this interface.
 244   virtual void addRelocation(const MachineRelocation &MR) = 0;
 245
 246
 247   /// FIXME: These should all be handled with relocations!
 248
 249   /// getConstantPoolEntryAddress - Return the address of the 'Index' entry in
 250   /// the constant pool that was last emitted with the emitConstantPool method.
 251   ///
 252   virtual intptr_t getConstantPoolEntryAddress(unsigned Index) const = 0;
 253
 254   /// getJumpTableEntryAddress - Return the address of the jump table with index
 255   /// 'Index' in the function that last called initJumpTableInfo.
 256   ///
 257   virtual intptr_t getJumpTableEntryAddress(unsigned Index) const = 0;
 258
 259   /// getMachineBasicBlockAddress - Return the address of the specified
 260   /// MachineBasicBlock, only usable after the label for the MBB has been
 261   /// emitted.
 262   ///
 263   virtual intptr_t getMachineBasicBlockAddress(MachineBasicBlock *MBB) const= 0;
 264
 265   /// getLabelAddress - Return the address of the specified LabelID, only usable
 266   /// after the LabelID has been emitted.
 267   ///
 268   virtual intptr_t getLabelAddress(uint64_t LabelID) const = 0;
 269
 270   /// Specifies the MachineModuleInfo object. This is used for exception handling
 271   /// purposes.
 272   virtual void setModuleInfo(MachineModuleInfo* Info) = 0;
 273 };
 274
 275 } // End llvm namespace
 276
 277 #endif