include/llvm/Target/TargetMachine.h

   1 //===-- llvm/Target/TargetMachine.h - Target Information --------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the TargetMachine and LLVMTargetMachine classes.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_TARGET_TARGETMACHINE_H
  15 #define LLVM_TARGET_TARGETMACHINE_H
  16
  17 #include "llvm/Target/TargetInstrItineraries.h"
  18 #include <cassert>
  19 #include <string>
  20
  21 namespace llvm {
  22
  23 class Target;
  24 class MCAsmInfo;
  25 class TargetData;
  26 class TargetSubtarget;
  27 class TargetInstrInfo;
  28 class TargetIntrinsicInfo;
  29 class TargetJITInfo;
  30 class TargetLowering;
  31 class TargetFrameInfo;
  32 class JITCodeEmitter;
  33 class MCContext;
  34 class TargetRegisterInfo;
  35 class PassManagerBase;
  36 class PassManager;
  37 class Pass;
  38 class TargetELFWriterInfo;
  39 class formatted_raw_ostream;
  40
  41 // Relocation model types.
  42 namespace Reloc {
  43   enum Model {
  44     Default,
  45     Static,
  46     PIC_,         // Cannot be named PIC due to collision with -DPIC
  47     DynamicNoPIC
  48   };
  49 }
  50
  51 // Code model types.
  52 namespace CodeModel {
  53   enum Model {
  54     Default,
  55     Small,
  56     Kernel,
  57     Medium,
  58     Large
  59   };
  60 }
  61
  62 // Code generation optimization level.
  63 namespace CodeGenOpt {
  64   enum Level {
  65     None,        // -O0
  66     Less,        // -O1
  67     Default,     // -O2, -Os
  68     Aggressive   // -O3
  69   };
  70 }
  71
  72 //===----------------------------------------------------------------------===//
  73 ///
  74 /// TargetMachine - Primary interface to the complete machine description for
  75 /// the target machine.  All target-specific information should be accessible
  76 /// through this interface.
  77 ///
  78 class TargetMachine {
  79   TargetMachine(const TargetMachine &);   // DO NOT IMPLEMENT
  80   void operator=(const TargetMachine &);  // DO NOT IMPLEMENT
  81 protected: // Can only create subclasses.
  82   TargetMachine(const Target &);
  83
  84   /// getSubtargetImpl - virtual method implemented by subclasses that returns
  85   /// a reference to that target's TargetSubtarget-derived member variable.
  86   virtual const TargetSubtarget *getSubtargetImpl() const { return 0; }
  87
  88   /// TheTarget - The Target that this machine was created for.
  89   const Target &TheTarget;
  90
  91   /// AsmInfo - Contains target specific asm information.
  92   ///
  93   const MCAsmInfo *AsmInfo;
  94
  95 public:
  96   virtual ~TargetMachine();
  97
  98   const Target &getTarget() const { return TheTarget; }
  99
 100   // Interfaces to the major aspects of target machine information:
 101   // -- Instruction opcode and operand information
 102   // -- Pipelines and scheduling information
 103   // -- Stack frame information
 104   // -- Selection DAG lowering information
 105   //
 106   virtual const TargetInstrInfo        *getInstrInfo() const { return 0; }
 107   virtual const TargetFrameInfo        *getFrameInfo() const { return 0; }
 108   virtual       TargetLowering    *getTargetLowering() const { return 0; }
 109   virtual const TargetData            *getTargetData() const { return 0; }
 110
 111   /// getMCAsmInfo - Return target specific asm information.
 112   ///
 113   const MCAsmInfo *getMCAsmInfo() const { return AsmInfo; }
 114
 115   /// getSubtarget - This method returns a pointer to the specified type of
 116   /// TargetSubtarget.  In debug builds, it verifies that the object being
 117   /// returned is of the correct type.
 118   template<typename STC> const STC &getSubtarget() const {
 119     return *static_cast<const STC*>(getSubtargetImpl());
 120   }
 121
 122   /// getRegisterInfo - If register information is available, return it.  If
 123   /// not, return null.  This is kept separate from RegInfo until RegInfo has
 124   /// details of graph coloring register allocation removed from it.
 125   ///
 126   virtual const TargetRegisterInfo *getRegisterInfo() const { return 0; }
 127
 128   /// getIntrinsicInfo - If intrinsic information is available, return it.  If
 129   /// not, return null.
 130   ///
 131   virtual const TargetIntrinsicInfo *getIntrinsicInfo() const { return 0; }
 132
 133   /// getJITInfo - If this target supports a JIT, return information for it,
 134   /// otherwise return null.
 135   ///
 136   virtual TargetJITInfo *getJITInfo() { return 0; }
 137
 138   /// getInstrItineraryData - Returns instruction itinerary data for the target
 139   /// or specific subtarget.
 140   ///
 141   virtual const InstrItineraryData getInstrItineraryData() const {
 142     return InstrItineraryData();
 143   }
 144
 145   /// getELFWriterInfo - If this target supports an ELF writer, return
 146   /// information for it, otherwise return null.
 147   ///
 148   virtual const TargetELFWriterInfo *getELFWriterInfo() const { return 0; }
 149
 150   /// getRelocationModel - Returns the code generation relocation model. The
 151   /// choices are static, PIC, and dynamic-no-pic, and target default.
 152   static Reloc::Model getRelocationModel();
 153
 154   /// setRelocationModel - Sets the code generation relocation model.
 155   ///
 156   static void setRelocationModel(Reloc::Model Model);
 157
 158   /// getCodeModel - Returns the code model. The choices are small, kernel,
 159   /// medium, large, and target default.
 160   static CodeModel::Model getCodeModel();
 161
 162   /// setCodeModel - Sets the code model.
 163   ///
 164   static void setCodeModel(CodeModel::Model Model);
 165
 166   /// getAsmVerbosityDefault - Returns the default value of asm verbosity.
 167   ///
 168   static bool getAsmVerbosityDefault();
 169
 170   /// setAsmVerbosityDefault - Set the default value of asm verbosity. Default
 171   /// is false.
 172   static void setAsmVerbosityDefault(bool);
 173
 174   /// CodeGenFileType - These enums are meant to be passed into
 175   /// addPassesToEmitFile to indicate what type of file to emit, and returned by
 176   /// it to indicate what type of file could actually be made.
 177   enum CodeGenFileType {
 178     CGFT_AssemblyFile,
 179     CGFT_ObjectFile,
 180     CGFT_Null         // Do not emit any output.
 181   };
 182
 183   /// getEnableTailMergeDefault - the default setting for -enable-tail-merge
 184   /// on this target.  User flag overrides.
 185   virtual bool getEnableTailMergeDefault() const { return true; }
 186
 187   /// addPassesToEmitFile - Add passes to the specified pass manager to get the
 188   /// specified file emitted.  Typically this will involve several steps of code
 189   /// generation.  This method should return true if emission of this file type
 190   /// is not supported, or false on success.
 191   virtual bool addPassesToEmitFile(PassManagerBase &,
 192                                    formatted_raw_ostream &,
 193                                    CodeGenFileType,
 194                                    CodeGenOpt::Level,
 195                                    bool = true) {
 196     return true;
 197   }
 198
 199   /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
 200   /// get machine code emitted.  This uses a JITCodeEmitter object to handle
 201   /// actually outputting the machine code and resolving things like the address
 202   /// of functions.  This method returns true if machine code emission is
 203   /// not supported.
 204   ///
 205   virtual bool addPassesToEmitMachineCode(PassManagerBase &,
 206                                           JITCodeEmitter &,
 207                                           CodeGenOpt::Level,
 208                                           bool = true) {
 209     return true;
 210   }
 211
 212   /// addPassesToEmitWholeFile - This method can be implemented by targets that
 213   /// require having the entire module at once.  This is not recommended, do not
 214   /// use this.
 215   virtual bool WantsWholeFile() const { return false; }
 216   virtual bool addPassesToEmitWholeFile(PassManager &, formatted_raw_ostream &,
 217                                         CodeGenFileType,
 218                                         CodeGenOpt::Level,
 219                                         bool = true) {
 220     return true;
 221   }
 222 };
 223
 224 /// LLVMTargetMachine - This class describes a target machine that is
 225 /// implemented with the LLVM target-independent code generator.
 226 ///
 227 class LLVMTargetMachine : public TargetMachine {
 228   std::string TargetTriple;
 229
 230 protected: // Can only create subclasses.
 231   LLVMTargetMachine(const Target &T, const std::string &TargetTriple);
 232
 233 private:
 234   /// addCommonCodeGenPasses - Add standard LLVM codegen passes used for
 235   /// both emitting to assembly files or machine code output.
 236   ///
 237   bool addCommonCodeGenPasses(PassManagerBase &, CodeGenOpt::Level,
 238                               bool DisableVerify, MCContext *&OutCtx);
 239
 240   virtual void setCodeModelForJIT();
 241   virtual void setCodeModelForStatic();
 242
 243 public:
 244
 245   /// addPassesToEmitFile - Add passes to the specified pass manager to get the
 246   /// specified file emitted.  Typically this will involve several steps of code
 247   /// generation.  If OptLevel is None, the code generator should emit code as
 248   /// fast as possible, though the generated code may be less efficient.
 249   virtual bool addPassesToEmitFile(PassManagerBase &PM,
 250                                    formatted_raw_ostream &Out,
 251                                    CodeGenFileType FileType,
 252                                    CodeGenOpt::Level,
 253                                    bool DisableVerify = true);
 254
 255   /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
 256   /// get machine code emitted.  This uses a JITCodeEmitter object to handle
 257   /// actually outputting the machine code and resolving things like the address
 258   /// of functions.  This method returns true if machine code emission is
 259   /// not supported.
 260   ///
 261   virtual bool addPassesToEmitMachineCode(PassManagerBase &PM,
 262                                           JITCodeEmitter &MCE,
 263                                           CodeGenOpt::Level,
 264                                           bool DisableVerify = true);
 265
 266   /// Target-Independent Code Generator Pass Configuration Options.
 267
 268   /// addInstSelector - This method should add any "last minute" LLVM->LLVM
 269   /// passes, then install an instruction selector pass, which converts from
 270   /// LLVM code to machine instructions.
 271   virtual bool addInstSelector(PassManagerBase &, CodeGenOpt::Level) {
 272     return true;
 273   }
 274
 275   /// addPreRegAlloc - This method may be implemented by targets that want to
 276   /// run passes immediately before register allocation. This should return
 277   /// true if -print-machineinstrs should print after these passes.
 278   virtual bool addPreRegAlloc(PassManagerBase &, CodeGenOpt::Level) {
 279     return false;
 280   }
 281
 282   /// addPostRegAlloc - This method may be implemented by targets that want
 283   /// to run passes after register allocation but before prolog-epilog
 284   /// insertion.  This should return true if -print-machineinstrs should print
 285   /// after these passes.
 286   virtual bool addPostRegAlloc(PassManagerBase &, CodeGenOpt::Level) {
 287     return false;
 288   }
 289
 290   /// addPreSched2 - This method may be implemented by targets that want to
 291   /// run passes after prolog-epilog insertion and before the second instruction
 292   /// scheduling pass.  This should return true if -print-machineinstrs should
 293   /// print after these passes.
 294   virtual bool addPreSched2(PassManagerBase &, CodeGenOpt::Level) {
 295     return false;
 296   }
 297
 298   /// addPreEmitPass - This pass may be implemented by targets that want to run
 299   /// passes immediately before machine code is emitted.  This should return
 300   /// true if -print-machineinstrs should print out the code after the passes.
 301   virtual bool addPreEmitPass(PassManagerBase &, CodeGenOpt::Level) {
 302     return false;
 303   }
 304
 305
 306   /// addCodeEmitter - This pass should be overridden by the target to add a
 307   /// code emitter, if supported.  If this is not supported, 'true' should be
 308   /// returned.
 309   virtual bool addCodeEmitter(PassManagerBase &, CodeGenOpt::Level,
 310                               JITCodeEmitter &) {
 311     return true;
 312   }
 313
 314   /// getEnableTailMergeDefault - the default setting for -enable-tail-merge
 315   /// on this target.  User flag overrides.
 316   virtual bool getEnableTailMergeDefault() const { return true; }
 317 };
 318
 319 } // End llvm namespace
 320
 321 #endif