1 //===-- llvm/Target/TargetMachine.h - Target Information --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the TargetMachine and LLVMTargetMachine classes.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_TARGET_TARGETMACHINE_H
15 #define LLVM_TARGET_TARGETMACHINE_H
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/ADT/Triple.h"
19 #include "llvm/IR/DataLayout.h"
20 #include "llvm/Pass.h"
21 #include "llvm/Support/CodeGen.h"
22 #include "llvm/Target/TargetOptions.h"
28 class InstrItineraryData;
31 class MachineFunctionInitializer;
37 class MCSubtargetInfo;
41 class TargetLibraryInfo;
42 class TargetFrameLowering;
43 class TargetIRAnalysis;
44 class TargetIntrinsicInfo;
46 class TargetPassConfig;
47 class TargetRegisterInfo;
48 class TargetSelectionDAGInfo;
49 class TargetSubtargetInfo;
50 class TargetTransformInfo;
51 class formatted_raw_ostream;
53 class raw_pwrite_stream;
54 class TargetLoweringObjectFile;
56 // The old pass manager infrastructure is hidden in a legacy namespace now.
58 class PassManagerBase;
60 using legacy::PassManagerBase;
62 //===----------------------------------------------------------------------===//
64 /// Primary interface to the complete machine description for the target
65 /// machine. All target-specific information should be accessible through this
69 TargetMachine(const TargetMachine &) = delete;
70 void operator=(const TargetMachine &) = delete;
71 protected: // Can only create subclasses.
72 TargetMachine(const Target &T, StringRef DataLayoutString,
73 const Triple &TargetTriple, StringRef CPU, StringRef FS,
74 const TargetOptions &Options);
76 /// The Target that this machine was created for.
77 const Target &TheTarget;
79 /// DataLayout for the target: keep ABI type size and alignment.
81 /// The DataLayout is created based on the string representation provided
82 /// during construction. It is kept here only to avoid reparsing the string
83 /// but should not really be used during compilation, because it has an
84 /// internal cache that is context specific.
87 /// Triple string, CPU name, and target feature strings the TargetMachine
88 /// instance is created with.
90 std::string TargetCPU;
93 /// Low level target information such as relocation model. Non-const to
94 /// allow resetting optimization level per-function.
95 MCCodeGenInfo *CodeGenInfo;
97 /// Contains target specific asm information.
98 const MCAsmInfo *AsmInfo;
100 const MCRegisterInfo *MRI;
101 const MCInstrInfo *MII;
102 const MCSubtargetInfo *STI;
104 unsigned RequireStructuredCFG : 1;
107 mutable TargetOptions Options;
109 virtual ~TargetMachine();
111 const Target &getTarget() const { return TheTarget; }
113 const Triple &getTargetTriple() const { return TargetTriple; }
114 StringRef getTargetCPU() const { return TargetCPU; }
115 StringRef getTargetFeatureString() const { return TargetFS; }
117 /// Virtual method implemented by subclasses that returns a reference to that
118 /// target's TargetSubtargetInfo-derived member variable.
119 virtual const TargetSubtargetInfo *getSubtargetImpl(const Function &) const {
122 virtual TargetLoweringObjectFile *getObjFileLowering() const {
126 /// This method returns a pointer to the specified type of
127 /// TargetSubtargetInfo. In debug builds, it verifies that the object being
128 /// returned is of the correct type.
129 template <typename STC> const STC &getSubtarget(const Function &F) const {
130 return *static_cast<const STC*>(getSubtargetImpl(F));
133 /// Create a DataLayout.
134 const DataLayout createDataLayout() const { return DL; }
136 /// Test if a DataLayout if compatible with the CodeGen for this target.
138 /// The LLVM Module owns a DataLayout that is used for the target independent
139 /// optimizations and code generation. This hook provides a target specific
140 /// check on the validity of this DataLayout.
141 bool isCompatibleDataLayout(const DataLayout &Candidate) const {
142 return DL == Candidate;
145 /// Get the pointer size for this target.
147 /// This is the only time the DataLayout in the TargetMachine is used.
148 unsigned getPointerSize() const { return DL.getPointerSize(); }
150 /// \brief Reset the target options based on the function's attributes.
151 // FIXME: Remove TargetOptions that affect per-function code generation
152 // from TargetMachine.
153 void resetTargetOptions(const Function &F) const;
155 /// Return target specific asm information.
156 const MCAsmInfo *getMCAsmInfo() const { return AsmInfo; }
158 const MCRegisterInfo *getMCRegisterInfo() const { return MRI; }
159 const MCInstrInfo *getMCInstrInfo() const { return MII; }
160 const MCSubtargetInfo *getMCSubtargetInfo() const { return STI; }
162 /// If intrinsic information is available, return it. If not, return null.
163 virtual const TargetIntrinsicInfo *getIntrinsicInfo() const {
167 bool requiresStructuredCFG() const { return RequireStructuredCFG; }
168 void setRequiresStructuredCFG(bool Value) { RequireStructuredCFG = Value; }
170 /// Returns the code generation relocation model. The choices are static, PIC,
171 /// and dynamic-no-pic, and target default.
172 Reloc::Model getRelocationModel() const;
174 /// Returns the code model. The choices are small, kernel, medium, large, and
176 CodeModel::Model getCodeModel() const;
178 /// Returns the TLS model which should be used for the given global variable.
179 TLSModel::Model getTLSModel(const GlobalValue *GV) const;
181 /// Returns the optimization level: None, Less, Default, or Aggressive.
182 CodeGenOpt::Level getOptLevel() const;
184 /// \brief Overrides the optimization level.
185 void setOptLevel(CodeGenOpt::Level Level) const;
187 void setFastISel(bool Enable) { Options.EnableFastISel = Enable; }
189 bool shouldPrintMachineCode() const { return Options.PrintMachineCode; }
191 /// Returns the default value of asm verbosity.
193 bool getAsmVerbosityDefault() const {
194 return Options.MCOptions.AsmVerbose;
197 bool getUniqueSectionNames() const { return Options.UniqueSectionNames; }
199 /// Return true if data objects should be emitted into their own section,
200 /// corresponds to -fdata-sections.
201 bool getDataSections() const {
202 return Options.DataSections;
205 /// Return true if functions should be emitted into their own section,
206 /// corresponding to -ffunction-sections.
207 bool getFunctionSections() const {
208 return Options.FunctionSections;
211 /// \brief Get a \c TargetIRAnalysis appropriate for the target.
213 /// This is used to construct the new pass manager's target IR analysis pass,
214 /// set up appropriately for this target machine. Even the old pass manager
215 /// uses this to answer queries about the IR.
216 virtual TargetIRAnalysis getTargetIRAnalysis();
218 /// These enums are meant to be passed into addPassesToEmitFile to indicate
219 /// what type of file to emit, and returned by it to indicate what type of
220 /// file could actually be made.
221 enum CodeGenFileType {
224 CGFT_Null // Do not emit any output.
227 /// Add passes to the specified pass manager to get the specified file
228 /// emitted. Typically this will involve several steps of code generation.
229 /// This method should return true if emission of this file type is not
230 /// supported, or false on success.
231 virtual bool addPassesToEmitFile(
232 PassManagerBase &, raw_pwrite_stream &, CodeGenFileType,
233 bool /*DisableVerify*/ = true, AnalysisID /*StartBefore*/ = nullptr,
234 AnalysisID /*StartAfter*/ = nullptr, AnalysisID /*StopAfter*/ = nullptr,
235 MachineFunctionInitializer * /*MFInitializer*/ = nullptr) {
239 /// Add passes to the specified pass manager to get machine code emitted with
240 /// the MCJIT. This method returns true if machine code is not supported. It
241 /// fills the MCContext Ctx pointer which can be used to build custom
244 virtual bool addPassesToEmitMC(PassManagerBase &, MCContext *&,
246 bool /*DisableVerify*/ = true) {
250 void getNameWithPrefix(SmallVectorImpl<char> &Name, const GlobalValue *GV,
251 Mangler &Mang, bool MayAlwaysUsePrivate = false) const;
252 MCSymbol *getSymbol(const GlobalValue *GV, Mangler &Mang) const;
255 /// This class describes a target machine that is implemented with the LLVM
256 /// target-independent code generator.
258 class LLVMTargetMachine : public TargetMachine {
259 protected: // Can only create subclasses.
260 LLVMTargetMachine(const Target &T, StringRef DataLayoutString,
261 const Triple &TargetTriple, StringRef CPU, StringRef FS,
262 TargetOptions Options, Reloc::Model RM, CodeModel::Model CM,
263 CodeGenOpt::Level OL);
267 /// \brief Get a TargetIRAnalysis implementation for the target.
269 /// This analysis will produce a TTI result which uses the common code
270 /// generator to answer queries about the IR.
271 TargetIRAnalysis getTargetIRAnalysis() override;
273 /// Create a pass configuration object to be used by addPassToEmitX methods
274 /// for generating a pipeline of CodeGen passes.
275 virtual TargetPassConfig *createPassConfig(PassManagerBase &PM);
277 /// Add passes to the specified pass manager to get the specified file
278 /// emitted. Typically this will involve several steps of code generation.
279 bool addPassesToEmitFile(
280 PassManagerBase &PM, raw_pwrite_stream &Out, CodeGenFileType FileType,
281 bool DisableVerify = true, AnalysisID StartBefore = nullptr,
282 AnalysisID StartAfter = nullptr, AnalysisID StopAfter = nullptr,
283 MachineFunctionInitializer *MFInitializer = nullptr) override;
285 /// Add passes to the specified pass manager to get machine code emitted with
286 /// the MCJIT. This method returns true if machine code is not supported. It
287 /// fills the MCContext Ctx pointer which can be used to build custom
289 bool addPassesToEmitMC(PassManagerBase &PM, MCContext *&Ctx,
290 raw_pwrite_stream &OS,
291 bool DisableVerify = true) override;
294 } // End llvm namespace