Changes For Bug 352

[oota-llvm.git] / include / llvm / CodeGen / MachineCodeEmitter.h

diff --git a/include/llvm/CodeGen/MachineCodeEmitter.h b/include/llvm/CodeGen/MachineCodeEmitter.h
index 6f47726de4699475445bf737204edc66ab6e6182..0daab91faf7691a4987ea1b8b7b8c5226e3547f0 100644 (file)
--- a/include/llvm/CodeGen/MachineCodeEmitter.h
+++ b/include/llvm/CodeGen/MachineCodeEmitter.h
@@ -1,19 +1,33 @@
 //===-- llvm/CodeGen/MachineCodeEmitter.h - Code emission -------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // This file defines an abstract interface that is used by the machine code
 // emission framework to output the code.  This allows machine code emission to
-// be seperated from concerns such as resolution of call targets, and where the
+// be separated from concerns such as resolution of call targets, and where the
 // machine code will be written (memory or disk, f.e.).
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef LLVM_CODEGEN_MACHINE_CODE_EMITTER_H
-#define LLVM_CODEGEN_MACHINE_CODE_EMITTER_H
+#ifndef LLVM_CODEGEN_MACHINECODEEMITTER_H
+#define LLVM_CODEGEN_MACHINECODEEMITTER_H
+
+#include <string>
+#include "llvm/Support/DataTypes.h"
+
+namespace llvm {
 
 class MachineFunction;
 class MachineBasicBlock;
+class MachineConstantPool;
 class Value;
 class GlobalValue;
+class Function;
 
 struct MachineCodeEmitter {
   virtual ~MachineCodeEmitter() {}
@@ -28,34 +42,78 @@ struct MachineCodeEmitter {
   ///
   virtual void finishFunction(MachineFunction &F) {}
 
-  /// startBasicBlock - This callback is invoked when a new basic block is about
-  /// to be emitted.
+  /// emitConstantPool - This callback is invoked to output the constant pool
+  /// for the function.
+  virtual void emitConstantPool(MachineConstantPool *MCP) {}
+
+  /// startFunctionStub - This callback is invoked when the JIT needs the
+  /// address of a function that has not been code generated yet.  The StubSize
+  /// specifies the total size required by the stub.  Stubs are not allowed to
+  /// have constant pools, the can only use the other emit* methods.
+  ///
+  virtual void startFunctionStub(const Function &F, unsigned StubSize) {}
+
+  /// finishFunctionStub - This callback is invoked to terminate a function
+  /// stub.
   ///
-  virtual void startBasicBlock(MachineBasicBlock &BB) {}
+  virtual void *finishFunctionStub(const Function &F) { return 0; }
 
   /// emitByte - This callback is invoked when a byte needs to be written to the
   /// output stream.
   ///
   virtual void emitByte(unsigned char B) {}
 
-  /// emitPCRelativeDisp - This callback is invoked when we need to write out a
-  /// PC relative displacement for the specified Value*.  This is used for call
-  /// and jump instructions typically.
+  /// emitWordAt - This callback is invoked when a word needs to be written to
+  /// the output stream at a different position than the current PC (for
+  /// instance, when performing relocations).
+  ///
+  virtual void emitWordAt(unsigned W, unsigned *Ptr) {}
+
+  /// emitWord - This callback is invoked when a word needs to be written to the
+  /// output stream.
   ///
-  virtual void emitPCRelativeDisp(Value *V) {}
+  virtual void emitWord(unsigned W) = 0;
 
-  /// emitGlobalAddress - This callback is invoked when we need to write out the
-  /// address of a global value to machine code.  This is important for indirect
-  /// calls as well as accessing global variables.
+  /// getGlobalValueAddress - This method is used to get the address of the
+  /// specified global value.  In some cases, however, the address may not yet
+  /// be known at the point that the method is called (for example, getting the
+  /// address of a function which has not yet been code generated).  If this is
+  /// the case, the function returns zero, and the callee has to be able to
+  /// handle the situation.
   ///
-  virtual void emitGlobalAddress(GlobalValue *V) {}
+  virtual uint64_t getGlobalValueAddress(GlobalValue *V) = 0;
+  virtual uint64_t getGlobalValueAddress(const std::string &Name) = 0;
 
+  // getConstantPoolEntryAddress - Return the address of the 'Index' entry in
+  // the constant pool that was last emitted with the 'emitConstantPool' method.
+  //
+  virtual uint64_t getConstantPoolEntryAddress(unsigned Index) = 0;
 
-  /// createDebugMachineCodeEmitter - Return a dynamically allocated machine
+  // getCurrentPCValue - This returns the address that the next emitted byte
+  // will be output to.
+  //
+  virtual uint64_t getCurrentPCValue() = 0;
+
+  // forceCompilationOf - Force the compilation of the specified function, and
+  // return its address, because we REALLY need the address now.
+  //
+  // FIXME: This is JIT specific!
+  //
+  virtual uint64_t forceCompilationOf(Function *F) = 0;
+  
+  /// createDebugEmitter - Return a dynamically allocated machine
   /// code emitter, which just prints the opcodes and fields out the cout.  This
   /// can be used for debugging users of the MachineCodeEmitter interface.
   ///
-  static MachineCodeEmitter *createDebugMachineCodeEmitter();
+  static MachineCodeEmitter *createDebugEmitter();
+
+  /// createFilePrinterEmitter - Return a dynamically allocated
+  /// machine code emitter, which prints binary code to a file.  This
+  /// can be used for debugging users of the MachineCodeEmitter interface.
+  ///
+  static MachineCodeEmitter *createFilePrinterEmitter(MachineCodeEmitter&);
 };
 
+} // End llvm namespace
+
 #endif