include/llvm/Target/TargetMachine.h

   1 //===-- llvm/Target/TargetMachine.h - Target Information --------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file describes the general parts of a Target machine.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_TARGET_TARGETMACHINE_H
  15 #define LLVM_TARGET_TARGETMACHINE_H
  16
  17 #include "llvm/Target/TargetData.h"
  18 #include <cassert>
  19
  20 namespace llvm {
  21
  22 class TargetInstrInfo;
  23 class TargetInstrDescriptor;
  24 class TargetJITInfo;
  25 class TargetSchedInfo;
  26 class SparcV9RegInfo;
  27 class TargetFrameInfo;
  28 class MachineCodeEmitter;
  29 class MRegisterInfo;
  30 class FunctionPassManager;
  31 class PassManager;
  32 class Pass;
  33 class IntrinsicLowering;
  34
  35 //===----------------------------------------------------------------------===//
  36 ///
  37 /// TargetMachine - Primary interface to the complete machine description for
  38 /// the target machine.  All target-specific information should be accessible
  39 /// through this interface.
  40 ///
  41 class TargetMachine {
  42   const std::string Name;
  43   const TargetData DataLayout;       // Calculates type size & alignment
  44   IntrinsicLowering *IL;             // Specifies how to lower intrinsic calls
  45
  46   TargetMachine(const TargetMachine&);   // DO NOT IMPLEMENT
  47   void operator=(const TargetMachine&);  // DO NOT IMPLEMENT
  48 protected: // Can only create subclasses...
  49   TargetMachine(const std::string &name, IntrinsicLowering *IL,
  50                 bool LittleEndian = false,
  51                 unsigned char PtrSize = 8, unsigned char PtrAl = 8,
  52                 unsigned char DoubleAl = 8, unsigned char FloatAl = 4,
  53                 unsigned char LongAl = 8, unsigned char IntAl = 4,
  54                 unsigned char ShortAl = 2, unsigned char ByteAl = 1);
  55
  56   /// This constructor is used for targets that support arbitrary TargetData
  57   /// layouts, like the C backend.  It initializes the TargetData to match that
  58   /// of the specified module.
  59   ///
  60   TargetMachine(const std::string &name, IntrinsicLowering *IL,
  61                 const Module &M);
  62 public:
  63   virtual ~TargetMachine();
  64
  65   /// getModuleMatchQuality - This static method should be implemented by
  66   /// targets to indicate how closely they match the specified module.  This is
  67   /// used by the LLC tool to determine which target to use when an explicit
  68   /// -march option is not specified.  If a target returns zero, it will never
  69   /// be chosen without an explicit -march option.
  70   static unsigned getModuleMatchQuality(const Module &M) { return 0; }
  71
  72   /// getJITMatchQuality - This static method should be implemented by targets
  73   /// that provide JIT capabilities to indicate how suitable they are for
  74   /// execution on the current host.  If a value of 0 is returned, the target
  75   /// will not be used unless an explicit -march option is used.
  76   static unsigned getJITMatchQuality() { return 0; }
  77
  78
  79   const std::string &getName() const { return Name; }
  80
  81   /// getIntrinsicLowering - This method returns a reference to an
  82   /// IntrinsicLowering instance which should be used by the code generator to
  83   /// lower unknown intrinsic functions to the equivalent LLVM expansion.
  84   ///
  85   IntrinsicLowering &getIntrinsicLowering() const { return *IL; }
  86
  87   // Interfaces to the major aspects of target machine information:
  88   // -- Instruction opcode and operand information
  89   // -- Pipelines and scheduling information
  90   // -- Stack frame information
  91   //
  92   virtual const TargetInstrInfo        *getInstrInfo() const { return 0; }
  93   virtual const TargetFrameInfo        *getFrameInfo() const { return 0; }
  94   const TargetData &getTargetData() const { return DataLayout; }
  95
  96   /// getRegisterInfo - If register information is available, return it.  If
  97   /// not, return null.  This is kept separate from RegInfo until RegInfo has
  98   /// details of graph coloring register allocation removed from it.
  99   ///
 100   virtual const MRegisterInfo*          getRegisterInfo() const { return 0; }
 101
 102   /// getJITInfo - If this target supports a JIT, return information for it,
 103   /// otherwise return null.
 104   ///
 105   virtual TargetJITInfo *getJITInfo() { return 0; }
 106
 107   // These are deprecated interfaces.
 108   virtual const TargetSchedInfo        *getSchedInfo() const { return 0; }
 109   virtual const SparcV9RegInfo         *getRegInfo()   const { return 0; }
 110
 111   /// addPassesToEmitAssembly - Add passes to the specified pass manager to get
 112   /// assembly langage code emitted.  Typically this will involve several steps
 113   /// of code generation.  This method should return true if assembly emission
 114   /// is not supported.
 115   ///
 116   virtual bool addPassesToEmitAssembly(PassManager &PM, std::ostream &Out) {
 117     return true;
 118   }
 119
 120   /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
 121   /// get machine code emitted.  This uses a MachineCodeEmitter object to handle
 122   /// actually outputting the machine code and resolving things like the address
 123   /// of functions.  This method should returns true if machine code emission is
 124   /// not supported.
 125   ///
 126   virtual bool addPassesToEmitMachineCode(FunctionPassManager &PM,
 127                                           MachineCodeEmitter &MCE) {
 128     return true;
 129   }
 130 };
 131
 132 } // End llvm namespace
 133
 134 #endif