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;
106 /// This API is here to support the C API, deprecated in 3.7 release.
107 /// This should never be used outside of legacy existing client.
108 const DataLayout &getDataLayout() const { return DL; }
109 friend struct C_API_PRIVATE_ACCESS;
112 mutable TargetOptions Options;
114 virtual ~TargetMachine();
116 const Target &getTarget() const { return TheTarget; }
118 const Triple &getTargetTriple() const { return TargetTriple; }
119 StringRef getTargetCPU() const { return TargetCPU; }
120 StringRef getTargetFeatureString() const { return TargetFS; }
122 /// Virtual method implemented by subclasses that returns a reference to that
123 /// target's TargetSubtargetInfo-derived member variable.
124 virtual const TargetSubtargetInfo *getSubtargetImpl(const Function &) const {
127 virtual TargetLoweringObjectFile *getObjFileLowering() const {
131 /// This method returns a pointer to the specified type of
132 /// TargetSubtargetInfo. In debug builds, it verifies that the object being
133 /// returned is of the correct type.
134 template <typename STC> const STC &getSubtarget(const Function &F) const {
135 return *static_cast<const STC*>(getSubtargetImpl(F));
138 /// Create a DataLayout.
139 const DataLayout createDataLayout() const { return DL; }
141 /// Test if a DataLayout if compatible with the CodeGen for this target.
143 /// The LLVM Module owns a DataLayout that is used for the target independent
144 /// optimizations and code generation. This hook provides a target specific
145 /// check on the validity of this DataLayout.
146 bool isCompatibleDataLayout(const DataLayout &Candidate) const {
147 return DL == Candidate;
150 /// Get the pointer size for this target.
152 /// This is the only time the DataLayout in the TargetMachine is used.
153 unsigned getPointerSize() const { return DL.getPointerSize(); }
155 /// \brief Reset the target options based on the function's attributes.
156 // FIXME: Remove TargetOptions that affect per-function code generation
157 // from TargetMachine.
158 void resetTargetOptions(const Function &F) const;
160 /// Return target specific asm information.
161 const MCAsmInfo *getMCAsmInfo() const { return AsmInfo; }
163 const MCRegisterInfo *getMCRegisterInfo() const { return MRI; }
164 const MCInstrInfo *getMCInstrInfo() const { return MII; }
165 const MCSubtargetInfo *getMCSubtargetInfo() const { return STI; }
167 /// If intrinsic information is available, return it. If not, return null.
168 virtual const TargetIntrinsicInfo *getIntrinsicInfo() const {
172 bool requiresStructuredCFG() const { return RequireStructuredCFG; }
173 void setRequiresStructuredCFG(bool Value) { RequireStructuredCFG = Value; }
175 /// Returns the code generation relocation model. The choices are static, PIC,
176 /// and dynamic-no-pic, and target default.
177 Reloc::Model getRelocationModel() const;
179 /// Returns the code model. The choices are small, kernel, medium, large, and
181 CodeModel::Model getCodeModel() const;
183 /// Returns the TLS model which should be used for the given global variable.
184 TLSModel::Model getTLSModel(const GlobalValue *GV) const;
186 /// Returns the optimization level: None, Less, Default, or Aggressive.
187 CodeGenOpt::Level getOptLevel() const;
189 /// \brief Overrides the optimization level.
190 void setOptLevel(CodeGenOpt::Level Level) const;
192 void setFastISel(bool Enable) { Options.EnableFastISel = Enable; }
194 bool shouldPrintMachineCode() const { return Options.PrintMachineCode; }
196 /// Returns the default value of asm verbosity.
198 bool getAsmVerbosityDefault() const {
199 return Options.MCOptions.AsmVerbose;
202 bool getUniqueSectionNames() const { return Options.UniqueSectionNames; }
204 /// Return true if data objects should be emitted into their own section,
205 /// corresponds to -fdata-sections.
206 bool getDataSections() const {
207 return Options.DataSections;
210 /// Return true if functions should be emitted into their own section,
211 /// corresponding to -ffunction-sections.
212 bool getFunctionSections() const {
213 return Options.FunctionSections;
216 /// \brief Get a \c TargetIRAnalysis appropriate for the target.
218 /// This is used to construct the new pass manager's target IR analysis pass,
219 /// set up appropriately for this target machine. Even the old pass manager
220 /// uses this to answer queries about the IR.
221 virtual TargetIRAnalysis getTargetIRAnalysis();
223 /// These enums are meant to be passed into addPassesToEmitFile to indicate
224 /// what type of file to emit, and returned by it to indicate what type of
225 /// file could actually be made.
226 enum CodeGenFileType {
229 CGFT_Null // Do not emit any output.
232 /// Add passes to the specified pass manager to get the specified file
233 /// emitted. Typically this will involve several steps of code generation.
234 /// This method should return true if emission of this file type is not
235 /// supported, or false on success.
236 virtual bool addPassesToEmitFile(
237 PassManagerBase &, raw_pwrite_stream &, CodeGenFileType,
238 bool /*DisableVerify*/ = true, AnalysisID /*StartBefore*/ = nullptr,
239 AnalysisID /*StartAfter*/ = nullptr, AnalysisID /*StopAfter*/ = nullptr,
240 MachineFunctionInitializer * /*MFInitializer*/ = nullptr) {
244 /// Add passes to the specified pass manager to get machine code emitted with
245 /// the MCJIT. This method returns true if machine code is not supported. It
246 /// fills the MCContext Ctx pointer which can be used to build custom
249 virtual bool addPassesToEmitMC(PassManagerBase &, MCContext *&,
251 bool /*DisableVerify*/ = true) {
255 void getNameWithPrefix(SmallVectorImpl<char> &Name, const GlobalValue *GV,
256 Mangler &Mang, bool MayAlwaysUsePrivate = false) const;
257 MCSymbol *getSymbol(const GlobalValue *GV, Mangler &Mang) const;
260 /// This class describes a target machine that is implemented with the LLVM
261 /// target-independent code generator.
263 class LLVMTargetMachine : public TargetMachine {
264 protected: // Can only create subclasses.
265 LLVMTargetMachine(const Target &T, StringRef DataLayoutString,
266 const Triple &TargetTriple, StringRef CPU, StringRef FS,
267 TargetOptions Options, Reloc::Model RM, CodeModel::Model CM,
268 CodeGenOpt::Level OL);
272 /// \brief Get a TargetIRAnalysis implementation for the target.
274 /// This analysis will produce a TTI result which uses the common code
275 /// generator to answer queries about the IR.
276 TargetIRAnalysis getTargetIRAnalysis() override;
278 /// Create a pass configuration object to be used by addPassToEmitX methods
279 /// for generating a pipeline of CodeGen passes.
280 virtual TargetPassConfig *createPassConfig(PassManagerBase &PM);
282 /// Add passes to the specified pass manager to get the specified file
283 /// emitted. Typically this will involve several steps of code generation.
284 bool addPassesToEmitFile(
285 PassManagerBase &PM, raw_pwrite_stream &Out, CodeGenFileType FileType,
286 bool DisableVerify = true, AnalysisID StartBefore = nullptr,
287 AnalysisID StartAfter = nullptr, AnalysisID StopAfter = nullptr,
288 MachineFunctionInitializer *MFInitializer = nullptr) override;
290 /// Add passes to the specified pass manager to get machine code emitted with
291 /// the MCJIT. This method returns true if machine code is not supported. It
292 /// fills the MCContext Ctx pointer which can be used to build custom
294 bool addPassesToEmitMC(PassManagerBase &PM, MCContext *&Ctx,
295 raw_pwrite_stream &OS,
296 bool DisableVerify = true) override;
299 } // End llvm namespace