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 MachineCodeEmitter;
  33 class JITCodeEmitter;
  34 class ObjectCodeEmitter;
  35 class TargetRegisterInfo;
  36 class PassManagerBase;
  37 class PassManager;
  38 class Pass;
  39 class TargetMachOWriterInfo;
  40 class TargetELFWriterInfo;
  41 class formatted_raw_ostream;
  42
  43 // Relocation model types.
  44 namespace Reloc {
  45   enum Model {
  46     Default,
  47     Static,
  48     PIC_,         // Cannot be named PIC due to collision with -DPIC
  49     DynamicNoPIC
  50   };
  51 }
  52
  53 // Code model types.
  54 namespace CodeModel {
  55   enum Model {
  56     Default,
  57     Small,
  58     Kernel,
  59     Medium,
  60     Large
  61   };
  62 }
  63
  64 namespace FileModel {
  65   enum Model {
  66     Error,
  67     None,
  68     AsmFile,
  69     MachOFile,
  70     ElfFile
  71   };
  72 }
  73
  74 // Code generation optimization level.
  75 namespace CodeGenOpt {
  76   enum Level {
  77     None,        // -O0
  78     Less,        // -O1
  79     Default,     // -O2, -Os
  80     Aggressive   // -O3
  81   };
  82 }
  83
  84
  85 //===----------------------------------------------------------------------===//
  86 ///
  87 /// TargetMachine - Primary interface to the complete machine description for
  88 /// the target machine.  All target-specific information should be accessible
  89 /// through this interface.
  90 ///
  91 class TargetMachine {
  92   TargetMachine(const TargetMachine &);   // DO NOT IMPLEMENT
  93   void operator=(const TargetMachine &);  // DO NOT IMPLEMENT
  94 protected: // Can only create subclasses.
  95   TargetMachine(const Target &);
  96
  97   /// getSubtargetImpl - virtual method implemented by subclasses that returns
  98   /// a reference to that target's TargetSubtarget-derived member variable.
  99   virtual const TargetSubtarget *getSubtargetImpl() const { return 0; }
 100
 101   /// TheTarget - The Target that this machine was created for.
 102   const Target &TheTarget;
 103
 104   /// AsmInfo - Contains target specific asm information.
 105   ///
 106   const MCAsmInfo *AsmInfo;
 107
 108 public:
 109   virtual ~TargetMachine();
 110
 111   const Target &getTarget() const { return TheTarget; }
 112
 113   // Interfaces to the major aspects of target machine information:
 114   // -- Instruction opcode and operand information
 115   // -- Pipelines and scheduling information
 116   // -- Stack frame information
 117   // -- Selection DAG lowering information
 118   //
 119   virtual const TargetInstrInfo        *getInstrInfo() const { return 0; }
 120   virtual const TargetFrameInfo        *getFrameInfo() const { return 0; }
 121   virtual       TargetLowering    *getTargetLowering() const { return 0; }
 122   virtual const TargetData            *getTargetData() const { return 0; }
 123
 124   /// getMCAsmInfo - Return target specific asm information.
 125   ///
 126   const MCAsmInfo *getMCAsmInfo() const { return AsmInfo; }
 127
 128   /// getSubtarget - This method returns a pointer to the specified type of
 129   /// TargetSubtarget.  In debug builds, it verifies that the object being
 130   /// returned is of the correct type.
 131   template<typename STC> const STC &getSubtarget() const {
 132     const TargetSubtarget *TST = getSubtargetImpl();
 133     assert(TST && dynamic_cast<const STC*>(TST) &&
 134            "Not the right kind of subtarget!");
 135     return *static_cast<const STC*>(TST);
 136   }
 137
 138   /// getRegisterInfo - If register information is available, return it.  If
 139   /// not, return null.  This is kept separate from RegInfo until RegInfo has
 140   /// details of graph coloring register allocation removed from it.
 141   ///
 142   virtual const TargetRegisterInfo *getRegisterInfo() const { return 0; }
 143
 144   /// getIntrinsicInfo - If intrinsic information is available, return it.  If
 145   /// not, return null.
 146   ///
 147   virtual const TargetIntrinsicInfo *getIntrinsicInfo() const { return 0; }
 148
 149   /// getJITInfo - If this target supports a JIT, return information for it,
 150   /// otherwise return null.
 151   ///
 152   virtual TargetJITInfo *getJITInfo() { return 0; }
 153
 154   /// getInstrItineraryData - Returns instruction itinerary data for the target
 155   /// or specific subtarget.
 156   ///
 157   virtual const InstrItineraryData getInstrItineraryData() const {
 158     return InstrItineraryData();
 159   }
 160
 161   /// getMachOWriterInfo - If this target supports a Mach-O writer, return
 162   /// information for it, otherwise return null.
 163   ///
 164   virtual const TargetMachOWriterInfo *getMachOWriterInfo() const { return 0; }
 165
 166   /// getELFWriterInfo - If this target supports an ELF writer, return
 167   /// information for it, otherwise return null.
 168   ///
 169   virtual const TargetELFWriterInfo *getELFWriterInfo() const { return 0; }
 170
 171   /// getRelocationModel - Returns the code generation relocation model. The
 172   /// choices are static, PIC, and dynamic-no-pic, and target default.
 173   static Reloc::Model getRelocationModel();
 174
 175   /// setRelocationModel - Sets the code generation relocation model.
 176   ///
 177   static void setRelocationModel(Reloc::Model Model);
 178
 179   /// getCodeModel - Returns the code model. The choices are small, kernel,
 180   /// medium, large, and target default.
 181   static CodeModel::Model getCodeModel();
 182
 183   /// setCodeModel - Sets the code model.
 184   ///
 185   static void setCodeModel(CodeModel::Model Model);
 186
 187   /// getAsmVerbosityDefault - Returns the default value of asm verbosity.
 188   ///
 189   static bool getAsmVerbosityDefault();
 190
 191   /// setAsmVerbosityDefault - Set the default value of asm verbosity. Default
 192   /// is false.
 193   static void setAsmVerbosityDefault(bool);
 194
 195   /// CodeGenFileType - These enums are meant to be passed into
 196   /// addPassesToEmitFile to indicate what type of file to emit.
 197   enum CodeGenFileType {
 198     AssemblyFile, ObjectFile, DynamicLibrary
 199   };
 200
 201   /// getEnableTailMergeDefault - the default setting for -enable-tail-merge
 202   /// on this target.  User flag overrides.
 203   virtual bool getEnableTailMergeDefault() const { return true; }
 204
 205   /// addPassesToEmitFile - Add passes to the specified pass manager to get the
 206   /// specified file emitted.  Typically this will involve several steps of code
 207   /// generation.
 208   /// This method should return FileModel::Error if emission of this file type
 209   /// is not supported.
 210   ///
 211   virtual FileModel::Model addPassesToEmitFile(PassManagerBase &,
 212                                                formatted_raw_ostream &,
 213                                                CodeGenFileType,
 214                                                CodeGenOpt::Level) {
 215     return FileModel::None;
 216   }
 217
 218   /// addPassesToEmitFileFinish - If the passes to emit the specified file had
 219   /// to be split up (e.g., to add an object writer pass), this method can be
 220   /// used to finish up adding passes to emit the file, if necessary.
 221   ///
 222   virtual bool addPassesToEmitFileFinish(PassManagerBase &,
 223                                          MachineCodeEmitter *,
 224                                          CodeGenOpt::Level) {
 225     return true;
 226   }
 227
 228   /// addPassesToEmitFileFinish - If the passes to emit the specified file had
 229   /// to be split up (e.g., to add an object writer pass), this method can be
 230   /// used to finish up adding passes to emit the file, if necessary.
 231   ///
 232   virtual bool addPassesToEmitFileFinish(PassManagerBase &,
 233                                          JITCodeEmitter *,
 234                                          CodeGenOpt::Level) {
 235     return true;
 236   }
 237
 238   /// addPassesToEmitFileFinish - If the passes to emit the specified file had
 239   /// to be split up (e.g., to add an object writer pass), this method can be
 240   /// used to finish up adding passes to emit the file, if necessary.
 241   ///
 242   virtual bool addPassesToEmitFileFinish(PassManagerBase &,
 243                                          ObjectCodeEmitter *,
 244                                          CodeGenOpt::Level) {
 245     return true;
 246   }
 247
 248   /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
 249   /// get machine code emitted.  This uses a MachineCodeEmitter object to handle
 250   /// actually outputting the machine code and resolving things like the address
 251   /// of functions.  This method returns true if machine code emission is
 252   /// not supported.
 253   ///
 254   virtual bool addPassesToEmitMachineCode(PassManagerBase &,
 255                                           MachineCodeEmitter &,
 256                                           CodeGenOpt::Level) {
 257     return true;
 258   }
 259
 260   /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
 261   /// get machine code emitted.  This uses a MachineCodeEmitter object to handle
 262   /// actually outputting the machine code and resolving things like the address
 263   /// of functions.  This method returns true if machine code emission is
 264   /// not supported.
 265   ///
 266   virtual bool addPassesToEmitMachineCode(PassManagerBase &,
 267                                           JITCodeEmitter &,
 268                                           CodeGenOpt::Level) {
 269     return true;
 270   }
 271
 272   /// addPassesToEmitWholeFile - This method can be implemented by targets that
 273   /// require having the entire module at once.  This is not recommended, do not
 274   /// use this.
 275   virtual bool WantsWholeFile() const { return false; }
 276   virtual bool addPassesToEmitWholeFile(PassManager &, formatted_raw_ostream &,
 277                                         CodeGenFileType,
 278                                         CodeGenOpt::Level) {
 279     return true;
 280   }
 281 };
 282
 283 /// LLVMTargetMachine - This class describes a target machine that is
 284 /// implemented with the LLVM target-independent code generator.
 285 ///
 286 class LLVMTargetMachine : public TargetMachine {
 287 protected: // Can only create subclasses.
 288   LLVMTargetMachine(const Target &T, const std::string &TargetTriple);
 289
 290   /// addCommonCodeGenPasses - Add standard LLVM codegen passes used for
 291   /// both emitting to assembly files or machine code output.
 292   ///
 293   bool addCommonCodeGenPasses(PassManagerBase &, CodeGenOpt::Level);
 294
 295 private:
 296   // These routines are used by addPassesToEmitFileFinish and
 297   // addPassesToEmitMachineCode to set the CodeModel if it's still marked
 298   // as default.
 299   virtual void setCodeModelForJIT();
 300   virtual void setCodeModelForStatic();
 301
 302 public:
 303
 304   /// addPassesToEmitFile - Add passes to the specified pass manager to get the
 305   /// specified file emitted.  Typically this will involve several steps of code
 306   /// generation.  If OptLevel is None, the code generator should emit code as fast
 307   /// as possible, though the generated code may be less efficient.  This method
 308   /// should return FileModel::Error if emission of this file type is not
 309   /// supported.
 310   ///
 311   /// The default implementation of this method adds components from the
 312   /// LLVM retargetable code generator, invoking the methods below to get
 313   /// target-specific passes in standard locations.
 314   ///
 315   virtual FileModel::Model addPassesToEmitFile(PassManagerBase &PM,
 316                                                formatted_raw_ostream &Out,
 317                                                CodeGenFileType FileType,
 318                                                CodeGenOpt::Level);
 319
 320   /// addPassesToEmitFileFinish - If the passes to emit the specified file had
 321   /// to be split up (e.g., to add an object writer pass), this method can be
 322   /// used to finish up adding passes to emit the file, if necessary.
 323   ///
 324   virtual bool addPassesToEmitFileFinish(PassManagerBase &PM,
 325                                          MachineCodeEmitter *MCE,
 326                                          CodeGenOpt::Level);
 327
 328   /// addPassesToEmitFileFinish - If the passes to emit the specified file had
 329   /// to be split up (e.g., to add an object writer pass), this method can be
 330   /// used to finish up adding passes to emit the file, if necessary.
 331   ///
 332   virtual bool addPassesToEmitFileFinish(PassManagerBase &PM,
 333                                          JITCodeEmitter *JCE,
 334                                          CodeGenOpt::Level);
 335
 336   /// addPassesToEmitFileFinish - If the passes to emit the specified file had
 337   /// to be split up (e.g., to add an object writer pass), this method can be
 338   /// used to finish up adding passes to emit the file, if necessary.
 339   ///
 340   virtual bool addPassesToEmitFileFinish(PassManagerBase &PM,
 341                                          ObjectCodeEmitter *OCE,
 342                                          CodeGenOpt::Level);
 343
 344   /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
 345   /// get machine code emitted.  This uses a MachineCodeEmitter object to handle
 346   /// actually outputting the machine code and resolving things like the address
 347   /// of functions.  This method returns true if machine code emission is
 348   /// not supported.
 349   ///
 350   virtual bool addPassesToEmitMachineCode(PassManagerBase &PM,
 351                                           MachineCodeEmitter &MCE,
 352                                           CodeGenOpt::Level);
 353
 354   /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
 355   /// get machine code emitted.  This uses a MachineCodeEmitter object to handle
 356   /// actually outputting the machine code and resolving things like the address
 357   /// of functions.  This method returns true if machine code emission is
 358   /// not supported.
 359   ///
 360   virtual bool addPassesToEmitMachineCode(PassManagerBase &PM,
 361                                           JITCodeEmitter &MCE,
 362                                           CodeGenOpt::Level);
 363
 364   /// Target-Independent Code Generator Pass Configuration Options.
 365
 366   /// addInstSelector - This method should add any "last minute" LLVM->LLVM
 367   /// passes, then install an instruction selector pass, which converts from
 368   /// LLVM code to machine instructions.
 369   virtual bool addInstSelector(PassManagerBase &, CodeGenOpt::Level) {
 370     return true;
 371   }
 372
 373   /// addPreRegAlloc - This method may be implemented by targets that want to
 374   /// run passes immediately before register allocation. This should return
 375   /// true if -print-machineinstrs should print after these passes.
 376   virtual bool addPreRegAlloc(PassManagerBase &, CodeGenOpt::Level) {
 377     return false;
 378   }
 379
 380   /// addPostRegAlloc - This method may be implemented by targets that want
 381   /// to run passes after register allocation but before prolog-epilog
 382   /// insertion.  This should return true if -print-machineinstrs should print
 383   /// after these passes.
 384   virtual bool addPostRegAlloc(PassManagerBase &, CodeGenOpt::Level) {
 385     return false;
 386   }
 387
 388   /// addPreSched2 - This method may be implemented by targets that want to
 389   /// run passes after prolog-epilog insertion and before the second instruction
 390   /// scheduling pass.  This should return true if -print-machineinstrs should
 391   /// print after these passes.
 392   virtual bool addPreSched2(PassManagerBase &, CodeGenOpt::Level) {
 393     return false;
 394   }
 395
 396   /// addPreEmitPass - This pass may be implemented by targets that want to run
 397   /// passes immediately before machine code is emitted.  This should return
 398   /// true if -print-machineinstrs should print out the code after the passes.
 399   virtual bool addPreEmitPass(PassManagerBase &, CodeGenOpt::Level) {
 400     return false;
 401   }
 402
 403
 404   /// addCodeEmitter - This pass should be overridden by the target to add a
 405   /// code emitter, if supported.  If this is not supported, 'true' should be
 406   /// returned.
 407   virtual bool addCodeEmitter(PassManagerBase &, CodeGenOpt::Level,
 408                               MachineCodeEmitter &) {
 409     return true;
 410   }
 411
 412   /// addCodeEmitter - This pass should be overridden by the target to add a
 413   /// code emitter, if supported.  If this is not supported, 'true' should be
 414   /// returned.
 415   virtual bool addCodeEmitter(PassManagerBase &, CodeGenOpt::Level,
 416                               JITCodeEmitter &) {
 417     return true;
 418   }
 419
 420   /// addSimpleCodeEmitter - This pass should be overridden by the target to add
 421   /// a code emitter (without setting flags), if supported.  If this is not
 422   /// supported, 'true' should be returned.
 423   virtual bool addSimpleCodeEmitter(PassManagerBase &, CodeGenOpt::Level,
 424                                     MachineCodeEmitter &) {
 425     return true;
 426   }
 427
 428   /// addSimpleCodeEmitter - This pass should be overridden by the target to add
 429   /// a code emitter (without setting flags), if supported.  If this is not
 430   /// supported, 'true' should be returned.
 431   virtual bool addSimpleCodeEmitter(PassManagerBase &, CodeGenOpt::Level,
 432                                     JITCodeEmitter &) {
 433     return true;
 434   }
 435
 436   /// addSimpleCodeEmitter - This pass should be overridden by the target to add
 437   /// a code emitter (without setting flags), if supported.  If this is not
 438   /// supported, 'true' should be returned.
 439   virtual bool addSimpleCodeEmitter(PassManagerBase &, CodeGenOpt::Level,
 440                                     ObjectCodeEmitter &) {
 441     return true;
 442   }
 443
 444   /// getEnableTailMergeDefault - the default setting for -enable-tail-merge
 445   /// on this target.  User flag overrides.
 446   virtual bool getEnableTailMergeDefault() const { return true; }
 447
 448   /// addAssemblyEmitter - Helper function which creates a target specific
 449   /// assembly printer, if available.
 450   ///
 451   /// \return Returns 'false' on success.
 452   bool addAssemblyEmitter(PassManagerBase &, CodeGenOpt::Level,
 453                           bool /* VerboseAsmDefault */,
 454                           formatted_raw_ostream &);
 455
 456   /// addObjectFileEmitter - Helper function which creates a target specific
 457   /// object files emitter, if available.  This interface is temporary, for
 458   /// bringing up MCAssembler-based object file emitters.
 459   ///
 460   /// \return Returns 'false' on success.
 461   bool addObjectFileEmitter(PassManagerBase &, CodeGenOpt::Level,
 462                             formatted_raw_ostream &);
 463 };
 464
 465 } // End llvm namespace
 466
 467 #endif