add a new isStoreToStackSlot method
[oota-llvm.git] / include / llvm / Target / TargetMachine.h
index abe3519bd3c0656efd2fa7559453064018995ba0..d13a4ed78df89688662f2e3e279b49a30f288509 100644 (file)
@@ -1,4 +1,11 @@
-//===-- llvm/Target/Machine.h - General Target Information -------*- C++ -*-==//
+//===-- llvm/Target/TargetMachine.h - Target Information --------*- 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 describes the general parts of a Target machine.
 //
 #define LLVM_TARGET_TARGETMACHINE_H
 
 #include "llvm/Target/TargetData.h"
-#include "Support/NonCopyable.h"
-
-class MachineInstrInfo;
-class MachineInstrDescriptor;
-class MachineSchedInfo;
-class MachineRegInfo;
-class MachineFrameInfo;
-class MachineCacheInfo;
-class MachineOptInfo;
+#include "llvm/Target/TargetInstrItineraries.h"
+#include <cassert>
+
+namespace llvm {
+
+class TargetSubtarget;
+class TargetInstrInfo;
+class TargetInstrDescriptor;
+class TargetJITInfo;
+class TargetSchedInfo;
+class SparcV9RegInfo;
+class TargetFrameInfo;
+class MachineCodeEmitter;
+class MRegisterInfo;
+class FunctionPassManager;
 class PassManager;
 class Pass;
+class IntrinsicLowering;
 
-//---------------------------------------------------------------------------
-// class TargetMachine
-// 
-// Purpose:
-//   Primary interface to the complete machine description for the
-//   target machine.  All target-specific information should be
-//   accessible through this interface.
-// 
-//---------------------------------------------------------------------------
-
-class TargetMachine : public NonCopyableV {
+//===----------------------------------------------------------------------===//
+///
+/// TargetMachine - Primary interface to the complete machine description for
+/// the target machine.  All target-specific information should be accessible
+/// through this interface.
+///
+class TargetMachine {
   const std::string Name;
+  const TargetData DataLayout;       // Calculates type size & alignment
+  IntrinsicLowering *IL;             // Specifies how to lower intrinsic calls
+
+  TargetMachine(const TargetMachine&);   // DO NOT IMPLEMENT
+  void operator=(const TargetMachine&);  // DO NOT IMPLEMENT
+protected: // Can only create subclasses...
+  TargetMachine(const std::string &name, IntrinsicLowering *IL,
+                bool LittleEndian = false,
+                unsigned char PtrSize = 8, unsigned char PtrAl = 8,
+                unsigned char DoubleAl = 8, unsigned char FloatAl = 4,
+                unsigned char LongAl = 8, unsigned char IntAl = 4,
+                unsigned char ShortAl = 2, unsigned char ByteAl = 1,
+                unsigned char BoolAl = 1);
+
+  TargetMachine(const std::string &name, IntrinsicLowering *IL,
+                const TargetData &TD);
+
+  /// This constructor is used for targets that support arbitrary TargetData
+  /// layouts, like the C backend.  It initializes the TargetData to match that
+  /// of the specified module.
+  ///
+  TargetMachine(const std::string &name, IntrinsicLowering *IL,
+                const Module &M);
+
+  /// getSubtargetImpl - virtual method implemented by subclasses that returns
+  /// a reference to that target's TargetSubtarget-derived member variable.
+  virtual const TargetSubtarget *getSubtargetImpl() const { return 0; }
 public:
-  const TargetData DataLayout;         // Calculates type size & alignment
-  
-protected:
-  TargetMachine(const std::string &name, // Can only create subclasses...
-                unsigned char SubWordSize = 1, unsigned char IntRegSize = 8,
-               unsigned char PtrSize = 8, unsigned char PtrAl = 8,
-               unsigned char DoubleAl = 8, unsigned char FloatAl = 4,
-               unsigned char LongAl = 8, unsigned char IntAl = 4,
-               unsigned char ShortAl = 2, unsigned char ByteAl = 1)
-    : Name(name), DataLayout(name, SubWordSize, IntRegSize, PtrSize, PtrAl,
-                             DoubleAl, FloatAl, LongAl,
-                             IntAl, ShortAl, ByteAl) {}
-public:
-  virtual ~TargetMachine() {}
+  virtual ~TargetMachine();
+
+  /// getModuleMatchQuality - This static method should be implemented by
+  /// targets to indicate how closely they match the specified module.  This is
+  /// used by the LLC tool to determine which target to use when an explicit
+  /// -march option is not specified.  If a target returns zero, it will never
+  /// be chosen without an explicit -march option.
+  static unsigned getModuleMatchQuality(const Module &M) { return 0; }
+
+  /// getJITMatchQuality - This static method should be implemented by targets
+  /// that provide JIT capabilities to indicate how suitable they are for
+  /// execution on the current host.  If a value of 0 is returned, the target
+  /// will not be used unless an explicit -march option is used.
+  static unsigned getJITMatchQuality() { return 0; }
+
 
   const std::string &getName() const { return Name; }
-  
-  // 
+
+  /// getIntrinsicLowering - This method returns a reference to an
+  /// IntrinsicLowering instance which should be used by the code generator to
+  /// lower unknown intrinsic functions to the equivalent LLVM expansion.
+  ///
+  IntrinsicLowering &getIntrinsicLowering() const { return *IL; }
+
   // Interfaces to the major aspects of target machine information:
   // -- Instruction opcode and operand information
   // -- Pipelines and scheduling information
-  // -- Register information
   // -- Stack frame information
-  // -- Cache hierarchy information
-  // -- Machine-level optimization information (peephole only)
-  // 
-  virtual const MachineInstrInfo&       getInstrInfo() const = 0;
-  virtual const MachineSchedInfo&       getSchedInfo() const = 0;
-  virtual const MachineRegInfo&                getRegInfo()   const = 0;
-  virtual const MachineFrameInfo&       getFrameInfo() const = 0;
-  virtual const MachineCacheInfo&       getCacheInfo() const = 0;
-  virtual const MachineOptInfo&         getOptInfo()   const = 0;
-
-  // Data storage information
-  // 
-  virtual unsigned findOptimalStorageSize(const Type* ty) const;
+  //
+  virtual const TargetInstrInfo        *getInstrInfo() const { return 0; }
+  virtual const TargetFrameInfo        *getFrameInfo() const { return 0; }
+  const TargetData &getTargetData() const { return DataLayout; }
+
+  /// getSubtarget - This method returns a pointer to the specified type of
+  /// TargetSubtarget.  In debug builds, it verifies that the object being
+  /// returned is of the correct type.
+  template<typename STC> const STC &getSubtarget() const {
+    const TargetSubtarget *TST = getSubtargetImpl();
+    assert(TST && dynamic_cast<const STC*>(TST) &&
+           "Not the right kind of subtarget!");
+    return *static_cast<const STC*>(TST);
+  }
+
+  /// getRegisterInfo - If register information is available, return it.  If
+  /// not, return null.  This is kept separate from RegInfo until RegInfo has
+  /// details of graph coloring register allocation removed from it.
+  ///
+  virtual const MRegisterInfo*          getRegisterInfo() const { return 0; }
+
+  /// getJITInfo - If this target supports a JIT, return information for it,
+  /// otherwise return null.
+  ///
+  virtual TargetJITInfo *getJITInfo() { return 0; }
   
-  /// addPassesToEmitAssembly - Add passes to the specified pass manager to get
-  /// assembly langage code emited.  Typically this will involve several steps
-  /// of code generation.  This method should return true if code generation is
-  /// not supported.
+  /// getInstrItineraryData - Returns instruction itinerary data for the target
+  /// or specific subtarget.
   ///
-  virtual bool addPassesToEmitAssembly(PassManager &PM, std::ostream &Out) {
+  virtual const InstrItineraryData getInstrItineraryData() const {  
+    return InstrItineraryData();
+  }
+
+  // These are deprecated interfaces.
+  virtual const TargetSchedInfo        *getSchedInfo() const { return 0; }
+  virtual const SparcV9RegInfo         *getRegInfo()   const { return 0; }
+
+  /// CodeGenFileType - These enums are meant to be passed into
+  /// addPassesToEmitFile to indicate what type of file to emit.
+  enum CodeGenFileType {
+    AssemblyFile, ObjectFile, DynamicLibrary
+  };
+
+  /// addPassesToEmitFile - Add passes to the specified pass manager to get
+  /// the specified file emitted.  Typically this will involve several steps of
+  /// code generation.  If Fast is set to true, the code generator should emit
+  /// code as fast as possible, without regard for compile time.  This method
+  /// should return true if emission of this file type is not supported.
+  ///
+  virtual bool addPassesToEmitFile(PassManager &PM, std::ostream &Out,
+                                   CodeGenFileType FileType, bool Fast) {
     return true;
   }
 
-  /// addPassesToJITCompile - Add passes to the specified pass manager to
-  /// implement a fast dynamic compiler for this target.  Return true if this is
-  /// not supported for this target.
+  /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
+  /// get machine code emitted.  This uses a MachineCodeEmitter object to handle
+  /// actually outputting the machine code and resolving things like the address
+  /// of functions.  This method should returns true if machine code emission is
+  /// not supported.
   ///
-  virtual bool addPassesToJITCompile(PassManager &PM) { return true; }
+  virtual bool addPassesToEmitMachineCode(FunctionPassManager &PM,
+                                          MachineCodeEmitter &MCE) {
+    return true;
+  }
 };
 
+} // End llvm namespace
+
 #endif