include/llvm/Target/TargetMachine.h

   1 //===-- llvm/Target/TargetMachine.h - Target Information --------*- C++ -*-===//
   2 //
   3 // This file describes the general parts of a Target machine.
   4 //
   5 //===----------------------------------------------------------------------===//
   6
   7 #ifndef LLVM_TARGET_TARGETMACHINE_H
   8 #define LLVM_TARGET_TARGETMACHINE_H
   9
  10 #include "llvm/Target/TargetData.h"
  11 #include <cassert>
  12
  13 class TargetInstrInfo;
  14 class TargetInstrDescriptor;
  15 class TargetSchedInfo;
  16 class TargetRegInfo;
  17 class TargetFrameInfo;
  18 class TargetCacheInfo;
  19 class MachineCodeEmitter;
  20 class MRegisterInfo;
  21 class FunctionPassManager;
  22 class PassManager;
  23 class Pass;
  24
  25 //===----------------------------------------------------------------------===//
  26 ///
  27 /// TargetMachine - Primary interface to the complete machine description for
  28 /// the target machine.  All target-specific information should be accessible
  29 /// through this interface.
  30 ///
  31 class TargetMachine {
  32   const std::string Name;
  33   const TargetData DataLayout;           // Calculates type size & alignment
  34
  35   TargetMachine(const TargetMachine&);   // DO NOT IMPLEMENT
  36   void operator=(const TargetMachine&);  // DO NOT IMPLEMENT
  37 protected:
  38   TargetMachine(const std::string &name, // Can only create subclasses...
  39                 bool LittleEndian = false,
  40                 unsigned char PtrSize = 8, unsigned char PtrAl = 8,
  41                 unsigned char DoubleAl = 8, unsigned char FloatAl = 4,
  42                 unsigned char LongAl = 8, unsigned char IntAl = 4,
  43                 unsigned char ShortAl = 2, unsigned char ByteAl = 1)
  44     : Name(name), DataLayout(name, LittleEndian,
  45                              PtrSize, PtrAl, DoubleAl, FloatAl, LongAl,
  46                              IntAl, ShortAl, ByteAl) {}
  47 public:
  48   virtual ~TargetMachine() {}
  49
  50   const std::string &getName() const { return Name; }
  51
  52   // Interfaces to the major aspects of target machine information:
  53   // -- Instruction opcode and operand information
  54   // -- Pipelines and scheduling information
  55   // -- Register information
  56   // -- Stack frame information
  57   // -- Cache hierarchy information
  58   // -- Machine-level optimization information (peephole only)
  59   //
  60   virtual const TargetInstrInfo&        getInstrInfo() const = 0;
  61   virtual const TargetSchedInfo&        getSchedInfo() const = 0;
  62   virtual const TargetRegInfo&          getRegInfo()   const = 0;
  63   virtual const TargetFrameInfo&        getFrameInfo() const = 0;
  64   virtual const TargetCacheInfo&        getCacheInfo() const = 0;
  65   const TargetData &getTargetData() const { return DataLayout; }
  66
  67   /// getRegisterInfo - If register information is available, return it.  If
  68   /// not, return null.  This is kept separate from RegInfo until RegInfo has
  69   /// details of graph coloring register allocation removed from it.
  70   ///
  71   virtual const MRegisterInfo*          getRegisterInfo() const { return 0; }
  72
  73   // Data storage information
  74   //
  75   virtual unsigned findOptimalStorageSize(const Type* ty) const;
  76
  77   /// addPassesToJITCompile - Add passes to the specified pass manager to
  78   /// implement a fast dynamic compiler for this target.  Return true if this is
  79   /// not supported for this target.
  80   ///
  81   virtual bool addPassesToJITCompile(FunctionPassManager &PM) { return true; }
  82
  83   /// addPassesToEmitAssembly - Add passes to the specified pass manager to get
  84   /// assembly langage code emitted.  Typically this will involve several steps
  85   /// of code generation.  This method should return true if assembly emission
  86   /// is not supported.
  87   ///
  88   virtual bool addPassesToEmitAssembly(PassManager &PM, std::ostream &Out) {
  89     return true;
  90   }
  91
  92   /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
  93   /// get machine code emitted.  This uses a MachineCodeEmitter object to handle
  94   /// actually outputting the machine code and resolving things like the address
  95   /// of functions.  This method should returns true if machine code emission is
  96   /// not supported.
  97   ///
  98   virtual bool addPassesToEmitMachineCode(FunctionPassManager &PM,
  99                                           MachineCodeEmitter &MCE) {
 100     return true;
 101   }
 102
 103   /// replaceMachineCodeForFunction - Make it so that calling the
 104   /// function whose machine code is at OLD turns into a call to NEW,
 105   /// perhaps by overwriting OLD with a branch to NEW. FIXME: this is
 106   /// JIT-specific.
 107   ///
 108   virtual void replaceMachineCodeForFunction (void *Old, void *New) {
 109     assert (0 && "Current target cannot replace machine code for functions");
 110   }
 111 };
 112
 113 #endif