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/ADT/StringRef.h"
  18 #include "llvm/Pass.h"
  19 #include "llvm/Support/CodeGen.h"
  20 #include "llvm/Target/TargetOptions.h"
  21 #include <cassert>
  22 #include <string>
  23
  24 namespace llvm {
  25
  26 class InstrItineraryData;
  27 class GlobalValue;
  28 class Mangler;
  29 class MCAsmInfo;
  30 class MCCodeGenInfo;
  31 class MCContext;
  32 class MCSymbol;
  33 class Target;
  34 class DataLayout;
  35 class TargetLibraryInfo;
  36 class TargetFrameLowering;
  37 class TargetIntrinsicInfo;
  38 class TargetLowering;
  39 class TargetPassConfig;
  40 class TargetRegisterInfo;
  41 class TargetSelectionDAGInfo;
  42 class TargetSubtargetInfo;
  43 class ScalarTargetTransformInfo;
  44 class VectorTargetTransformInfo;
  45 class formatted_raw_ostream;
  46 class raw_ostream;
  47
  48 // The old pass manager infrastructure is hidden in a legacy namespace now.
  49 namespace legacy {
  50 class PassManagerBase;
  51 }
  52 using legacy::PassManagerBase;
  53
  54 //===----------------------------------------------------------------------===//
  55 ///
  56 /// TargetMachine - Primary interface to the complete machine description for
  57 /// the target machine.  All target-specific information should be accessible
  58 /// through this interface.
  59 ///
  60 class TargetMachine {
  61   TargetMachine(const TargetMachine &) LLVM_DELETED_FUNCTION;
  62   void operator=(const TargetMachine &) LLVM_DELETED_FUNCTION;
  63 protected: // Can only create subclasses.
  64   TargetMachine(const Target &T, StringRef TargetTriple,
  65                 StringRef CPU, StringRef FS, const TargetOptions &Options);
  66
  67   /// TheTarget - The Target that this machine was created for.
  68   const Target &TheTarget;
  69
  70   /// TargetTriple, TargetCPU, TargetFS - Triple string, CPU name, and target
  71   /// feature strings the TargetMachine instance is created with.
  72   std::string TargetTriple;
  73   std::string TargetCPU;
  74   std::string TargetFS;
  75
  76   /// CodeGenInfo - Low level target information such as relocation model.
  77   /// Non-const to allow resetting optimization level per-function.
  78   MCCodeGenInfo *CodeGenInfo;
  79
  80   /// AsmInfo - Contains target specific asm information.
  81   ///
  82   const MCAsmInfo *AsmInfo;
  83
  84   unsigned RequireStructuredCFG : 1;
  85
  86 public:
  87   mutable TargetOptions Options;
  88
  89   virtual ~TargetMachine();
  90
  91   const Target &getTarget() const { return TheTarget; }
  92
  93   StringRef getTargetTriple() const { return TargetTriple; }
  94   StringRef getTargetCPU() const { return TargetCPU; }
  95   StringRef getTargetFeatureString() const { return TargetFS; }
  96
  97   /// getSubtargetImpl - virtual method implemented by subclasses that returns
  98   /// a reference to that target's TargetSubtargetInfo-derived member variable.
  99   virtual const TargetSubtargetInfo *getSubtargetImpl() const {
 100     return nullptr;
 101   }
 102   virtual const TargetSubtargetInfo *getSubtargetImpl(const Function *) const {
 103     return getSubtargetImpl();
 104   }
 105
 106   /// getSubtarget - This method returns a pointer to the specified type of
 107   /// TargetSubtargetInfo.  In debug builds, it verifies that the object being
 108   /// returned is of the correct type.
 109   template<typename STC> const STC &getSubtarget() const {
 110     return *static_cast<const STC*>(getSubtargetImpl());
 111   }
 112   template <typename STC> const STC &getSubtarget(const Function *) const {
 113     return *static_cast<const STC*>(getSubtargetImpl());
 114   }
 115
 116   /// \brief Reset the target options based on the function's attributes.
 117   void resetTargetOptions(const MachineFunction *MF) const;
 118
 119   /// getMCAsmInfo - Return target specific asm information.
 120   ///
 121   const MCAsmInfo *getMCAsmInfo() const { return AsmInfo; }
 122
 123   /// getIntrinsicInfo - If intrinsic information is available, return it.  If
 124   /// not, return null.
 125   ///
 126   virtual const TargetIntrinsicInfo *getIntrinsicInfo() const {
 127     return nullptr;
 128   }
 129
 130   bool requiresStructuredCFG() const { return RequireStructuredCFG; }
 131   void setRequiresStructuredCFG(bool Value) { RequireStructuredCFG = Value; }
 132
 133   /// getRelocationModel - Returns the code generation relocation model. The
 134   /// choices are static, PIC, and dynamic-no-pic, and target default.
 135   Reloc::Model getRelocationModel() const;
 136
 137   /// getCodeModel - Returns the code model. The choices are small, kernel,
 138   /// medium, large, and target default.
 139   CodeModel::Model getCodeModel() const;
 140
 141   /// getTLSModel - Returns the TLS model which should be used for the given
 142   /// global variable.
 143   TLSModel::Model getTLSModel(const GlobalValue *GV) const;
 144
 145   /// getOptLevel - Returns the optimization level: None, Less,
 146   /// Default, or Aggressive.
 147   CodeGenOpt::Level getOptLevel() const;
 148
 149   /// \brief Overrides the optimization level.
 150   void setOptLevel(CodeGenOpt::Level Level) const;
 151
 152   void setFastISel(bool Enable) { Options.EnableFastISel = Enable; }
 153
 154   bool shouldPrintMachineCode() const { return Options.PrintMachineCode; }
 155
 156   /// getAsmVerbosityDefault - Returns the default value of asm verbosity.
 157   ///
 158   bool getAsmVerbosityDefault() const ;
 159
 160   /// setAsmVerbosityDefault - Set the default value of asm verbosity. Default
 161   /// is false.
 162   void setAsmVerbosityDefault(bool);
 163
 164   /// getDataSections - Return true if data objects should be emitted into their
 165   /// own section, corresponds to -fdata-sections.
 166   bool getDataSections() const;
 167
 168   /// getFunctionSections - Return true if functions should be emitted into
 169   /// their own section, corresponding to -ffunction-sections.
 170   bool getFunctionSections() const;
 171
 172   /// setDataSections - Set if the data are emit into separate sections.
 173   void setDataSections(bool);
 174
 175   /// setFunctionSections - Set if the functions are emit into separate
 176   /// sections.
 177   void setFunctionSections(bool);
 178
 179   /// \brief Register analysis passes for this target with a pass manager.
 180   virtual void addAnalysisPasses(PassManagerBase &) {}
 181
 182   /// CodeGenFileType - These enums are meant to be passed into
 183   /// addPassesToEmitFile to indicate what type of file to emit, and returned by
 184   /// it to indicate what type of file could actually be made.
 185   enum CodeGenFileType {
 186     CGFT_AssemblyFile,
 187     CGFT_ObjectFile,
 188     CGFT_Null         // Do not emit any output.
 189   };
 190
 191   /// addPassesToEmitFile - Add passes to the specified pass manager to get the
 192   /// specified file emitted.  Typically this will involve several steps of code
 193   /// generation.  This method should return true if emission of this file type
 194   /// is not supported, or false on success.
 195   virtual bool addPassesToEmitFile(PassManagerBase &,
 196                                    formatted_raw_ostream &,
 197                                    CodeGenFileType,
 198                                    bool /*DisableVerify*/ = true,
 199                                    AnalysisID /*StartAfter*/ = nullptr,
 200                                    AnalysisID /*StopAfter*/ = nullptr) {
 201     return true;
 202   }
 203
 204   /// addPassesToEmitMC - Add passes to the specified pass manager to get
 205   /// machine code emitted with the MCJIT. This method returns true if machine
 206   /// code is not supported. It fills the MCContext Ctx pointer which can be
 207   /// used to build custom MCStreamer.
 208   ///
 209   virtual bool addPassesToEmitMC(PassManagerBase &,
 210                                  MCContext *&,
 211                                  raw_ostream &,
 212                                  bool /*DisableVerify*/ = true) {
 213     return true;
 214   }
 215
 216   void getNameWithPrefix(SmallVectorImpl<char> &Name, const GlobalValue *GV,
 217                          Mangler &Mang, bool MayAlwaysUsePrivate = false) const;
 218   MCSymbol *getSymbol(const GlobalValue *GV, Mangler &Mang) const;
 219 };
 220
 221 /// LLVMTargetMachine - This class describes a target machine that is
 222 /// implemented with the LLVM target-independent code generator.
 223 ///
 224 class LLVMTargetMachine : public TargetMachine {
 225 protected: // Can only create subclasses.
 226   LLVMTargetMachine(const Target &T, StringRef TargetTriple,
 227                     StringRef CPU, StringRef FS, TargetOptions Options,
 228                     Reloc::Model RM, CodeModel::Model CM,
 229                     CodeGenOpt::Level OL);
 230
 231   void initAsmInfo();
 232 public:
 233   /// \brief Register analysis passes for this target with a pass manager.
 234   ///
 235   /// This registers target independent analysis passes.
 236   void addAnalysisPasses(PassManagerBase &PM) override;
 237
 238   /// createPassConfig - Create a pass configuration object to be used by
 239   /// addPassToEmitX methods for generating a pipeline of CodeGen passes.
 240   virtual TargetPassConfig *createPassConfig(PassManagerBase &PM);
 241
 242   /// addPassesToEmitFile - Add passes to the specified pass manager to get the
 243   /// specified file emitted.  Typically this will involve several steps of code
 244   /// generation.
 245   bool addPassesToEmitFile(PassManagerBase &PM, formatted_raw_ostream &Out,
 246                            CodeGenFileType FileType, bool DisableVerify = true,
 247                            AnalysisID StartAfter = nullptr,
 248                            AnalysisID StopAfter = nullptr) override;
 249
 250   /// addPassesToEmitMC - Add passes to the specified pass manager to get
 251   /// machine code emitted with the MCJIT. This method returns true if machine
 252   /// code is not supported. It fills the MCContext Ctx pointer which can be
 253   /// used to build custom MCStreamer.
 254   ///
 255   bool addPassesToEmitMC(PassManagerBase &PM, MCContext *&Ctx,
 256                          raw_ostream &OS, bool DisableVerify = true) override;
 257 };
 258
 259 } // End llvm namespace
 260
 261 #endif