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/Pass.h"
19 #include "llvm/Support/CodeGen.h"
20 #include "llvm/Target/TargetOptions.h"
26 class InstrItineraryData;
36 class TargetLibraryInfo;
37 class TargetFrameLowering;
38 class TargetIntrinsicInfo;
41 class TargetPassConfig;
42 class TargetRegisterInfo;
43 class TargetSelectionDAGInfo;
44 class TargetSubtargetInfo;
45 class ScalarTargetTransformInfo;
46 class VectorTargetTransformInfo;
47 class formatted_raw_ostream;
50 // The old pass manager infrastructure is hidden in a legacy namespace now.
52 class PassManagerBase;
54 using legacy::PassManagerBase;
56 //===----------------------------------------------------------------------===//
58 /// TargetMachine - Primary interface to the complete machine description for
59 /// the target machine. All target-specific information should be accessible
60 /// through this interface.
63 TargetMachine(const TargetMachine &) LLVM_DELETED_FUNCTION;
64 void operator=(const TargetMachine &) LLVM_DELETED_FUNCTION;
65 protected: // Can only create subclasses.
66 TargetMachine(const Target &T, StringRef TargetTriple,
67 StringRef CPU, StringRef FS, const TargetOptions &Options);
69 /// TheTarget - The Target that this machine was created for.
70 const Target &TheTarget;
72 /// TargetTriple, TargetCPU, TargetFS - Triple string, CPU name, and target
73 /// feature strings the TargetMachine instance is created with.
74 std::string TargetTriple;
75 std::string TargetCPU;
78 /// CodeGenInfo - Low level target information such as relocation model.
79 /// Non-const to allow resetting optimization level per-function.
80 MCCodeGenInfo *CodeGenInfo;
82 /// AsmInfo - Contains target specific asm information.
84 const MCAsmInfo *AsmInfo;
86 unsigned RequireStructuredCFG : 1;
89 virtual ~TargetMachine();
91 const Target &getTarget() const { return TheTarget; }
93 const StringRef getTargetTriple() const { return TargetTriple; }
94 const StringRef getTargetCPU() const { return TargetCPU; }
95 const StringRef getTargetFeatureString() const { return TargetFS; }
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 {
102 virtual TargetSubtargetInfo *getSubtargetImpl() {
103 const TargetMachine *TM = this;
104 return const_cast<TargetSubtargetInfo *>(TM->getSubtargetImpl());
107 mutable TargetOptions Options;
109 /// \brief Reset the target options based on the function's attributes.
110 void resetTargetOptions(const MachineFunction *MF) const;
112 /// getMCAsmInfo - Return target specific asm information.
114 const MCAsmInfo *getMCAsmInfo() const { return AsmInfo; }
116 /// getSubtarget - This method returns a pointer to the specified type of
117 /// TargetSubtargetInfo. In debug builds, it verifies that the object being
118 /// returned is of the correct type.
119 template<typename STC> const STC &getSubtarget() const {
120 return *static_cast<const STC*>(getSubtargetImpl());
123 /// getIntrinsicInfo - If intrinsic information is available, return it. If
124 /// not, return null.
126 virtual const TargetIntrinsicInfo *getIntrinsicInfo() const {
130 bool requiresStructuredCFG() const { return RequireStructuredCFG; }
131 void setRequiresStructuredCFG(bool Value) { RequireStructuredCFG = Value; }
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;
137 /// getCodeModel - Returns the code model. The choices are small, kernel,
138 /// medium, large, and target default.
139 CodeModel::Model getCodeModel() const;
141 /// getTLSModel - Returns the TLS model which should be used for the given
143 TLSModel::Model getTLSModel(const GlobalValue *GV) const;
145 /// getOptLevel - Returns the optimization level: None, Less,
146 /// Default, or Aggressive.
147 CodeGenOpt::Level getOptLevel() const;
149 /// \brief Overrides the optimization level.
150 void setOptLevel(CodeGenOpt::Level Level) const;
152 void setFastISel(bool Enable) { Options.EnableFastISel = Enable; }
154 bool shouldPrintMachineCode() const { return Options.PrintMachineCode; }
156 /// getAsmVerbosityDefault - Returns the default value of asm verbosity.
158 bool getAsmVerbosityDefault() const ;
160 /// setAsmVerbosityDefault - Set the default value of asm verbosity. Default
162 void setAsmVerbosityDefault(bool);
164 /// getDataSections - Return true if data objects should be emitted into their
165 /// own section, corresponds to -fdata-sections.
166 bool getDataSections() const;
168 /// getFunctionSections - Return true if functions should be emitted into
169 /// their own section, corresponding to -ffunction-sections.
170 bool getFunctionSections() const;
172 /// setDataSections - Set if the data are emit into separate sections.
173 void setDataSections(bool);
175 /// setFunctionSections - Set if the functions are emit into separate
177 void setFunctionSections(bool);
179 /// \brief Register analysis passes for this target with a pass manager.
180 virtual void addAnalysisPasses(PassManagerBase &) {}
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 {
188 CGFT_Null // Do not emit any output.
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 &,
198 bool /*DisableVerify*/ = true,
199 AnalysisID /*StartAfter*/ = nullptr,
200 AnalysisID /*StopAfter*/ = nullptr) {
204 /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
205 /// get machine code emitted. This uses a JITCodeEmitter object to handle
206 /// actually outputting the machine code and resolving things like the address
207 /// of functions. This method returns true if machine code emission is
210 virtual bool addPassesToEmitMachineCode(PassManagerBase &,
212 bool /*DisableVerify*/ = true) {
216 /// addPassesToEmitMC - Add passes to the specified pass manager to get
217 /// machine code emitted with the MCJIT. This method returns true if machine
218 /// code is not supported. It fills the MCContext Ctx pointer which can be
219 /// used to build custom MCStreamer.
221 virtual bool addPassesToEmitMC(PassManagerBase &,
224 bool /*DisableVerify*/ = true) {
228 void getNameWithPrefix(SmallVectorImpl<char> &Name, const GlobalValue *GV,
229 Mangler &Mang, bool MayAlwaysUsePrivate = false) const;
230 MCSymbol *getSymbol(const GlobalValue *GV, Mangler &Mang) const;
233 /// LLVMTargetMachine - This class describes a target machine that is
234 /// implemented with the LLVM target-independent code generator.
236 class LLVMTargetMachine : public TargetMachine {
237 protected: // Can only create subclasses.
238 LLVMTargetMachine(const Target &T, StringRef TargetTriple,
239 StringRef CPU, StringRef FS, TargetOptions Options,
240 Reloc::Model RM, CodeModel::Model CM,
241 CodeGenOpt::Level OL);
245 /// \brief Register analysis passes for this target with a pass manager.
247 /// This registers target independent analysis passes.
248 void addAnalysisPasses(PassManagerBase &PM) override;
250 /// createPassConfig - Create a pass configuration object to be used by
251 /// addPassToEmitX methods for generating a pipeline of CodeGen passes.
252 virtual TargetPassConfig *createPassConfig(PassManagerBase &PM);
254 /// addPassesToEmitFile - Add passes to the specified pass manager to get the
255 /// specified file emitted. Typically this will involve several steps of code
257 bool addPassesToEmitFile(PassManagerBase &PM, formatted_raw_ostream &Out,
258 CodeGenFileType FileType, bool DisableVerify = true,
259 AnalysisID StartAfter = nullptr,
260 AnalysisID StopAfter = nullptr) override;
262 /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
263 /// get machine code emitted. This uses a JITCodeEmitter object to handle
264 /// actually outputting the machine code and resolving things like the address
265 /// of functions. This method returns true if machine code emission is
268 bool addPassesToEmitMachineCode(PassManagerBase &PM, JITCodeEmitter &MCE,
269 bool DisableVerify = true) override;
271 /// addPassesToEmitMC - Add passes to the specified pass manager to get
272 /// machine code emitted with the MCJIT. This method returns true if machine
273 /// code is not supported. It fills the MCContext Ctx pointer which can be
274 /// used to build custom MCStreamer.
276 bool addPassesToEmitMC(PassManagerBase &PM, MCContext *&Ctx,
277 raw_ostream &OS, bool DisableVerify = true) override;
279 /// addCodeEmitter - This pass should be overridden by the target to add a
280 /// code emitter, if supported. If this is not supported, 'true' should be
282 virtual bool addCodeEmitter(PassManagerBase &,
288 } // End llvm namespace