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 TargetRegInfo;
  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   TargetMachine(const std::string &name, IntrinsicLowering *IL,
  60                 const Module &M);
  61 public:
  62   virtual ~TargetMachine();
  63
  64   const std::string &getName() const { return Name; }
  65
  66   // getIntrinsicLowering - This method returns a reference to an
  67   // IntrinsicLowering instance which should be used by the code generator to
  68   // lower unknown intrinsic functions to the equivalent LLVM expansion.
  69   IntrinsicLowering &getIntrinsicLowering() const { return *IL; }
  70
  71   // Interfaces to the major aspects of target machine information:
  72   // -- Instruction opcode and operand information
  73   // -- Pipelines and scheduling information
  74   // -- Register information
  75   // -- Stack frame information
  76   // -- Cache hierarchy information
  77   // -- Machine-level optimization information (peephole only)
  78   //
  79   virtual const TargetInstrInfo&        getInstrInfo() const = 0;
  80   virtual const TargetSchedInfo&        getSchedInfo() const = 0;
  81   virtual const TargetRegInfo&          getRegInfo()   const = 0;
  82   virtual const TargetFrameInfo&        getFrameInfo() const = 0;
  83   const TargetData &getTargetData() const { return DataLayout; }
  84
  85   /// getRegisterInfo - If register information is available, return it.  If
  86   /// not, return null.  This is kept separate from RegInfo until RegInfo has
  87   /// details of graph coloring register allocation removed from it.
  88   ///
  89   virtual const MRegisterInfo*          getRegisterInfo() const { return 0; }
  90
  91   /// getJITInfo - If this target supports a JIT, return information for it,
  92   /// otherwise return null.
  93   ///
  94   virtual TargetJITInfo *getJITInfo() { return 0; }
  95
  96   // Data storage information.  FIXME, this should be moved out to sparc
  97   // specific code.
  98   //
  99   virtual unsigned findOptimalStorageSize(const Type* ty) const;
 100
 101   /// addPassesToEmitAssembly - Add passes to the specified pass manager to get
 102   /// assembly langage code emitted.  Typically this will involve several steps
 103   /// of code generation.  This method should return true if assembly emission
 104   /// is not supported.
 105   ///
 106   virtual bool addPassesToEmitAssembly(PassManager &PM, std::ostream &Out) {
 107     return true;
 108   }
 109
 110   /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
 111   /// get machine code emitted.  This uses a MachineCodeEmitter object to handle
 112   /// actually outputting the machine code and resolving things like the address
 113   /// of functions.  This method should returns true if machine code emission is
 114   /// not supported.
 115   ///
 116   virtual bool addPassesToEmitMachineCode(FunctionPassManager &PM,
 117                                           MachineCodeEmitter &MCE) {
 118     return true;
 119   }
 120 };
 121
 122 } // End llvm namespace
 123
 124 #endif