Use 'override/final' instead of 'virtual' for overridden methods
[oota-llvm.git] / lib / Target / PowerPC / PPCSubtarget.h
1 //===-- PPCSubtarget.h - Define Subtarget for the PPC ----------*- 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 declares the PowerPC specific subclass of TargetSubtargetInfo.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_LIB_TARGET_POWERPC_PPCSUBTARGET_H
15 #define LLVM_LIB_TARGET_POWERPC_PPCSUBTARGET_H
16
17 #include "PPCFrameLowering.h"
18 #include "PPCISelLowering.h"
19 #include "PPCInstrInfo.h"
20 #include "PPCSelectionDAGInfo.h"
21 #include "llvm/ADT/Triple.h"
22 #include "llvm/IR/DataLayout.h"
23 #include "llvm/MC/MCInstrItineraries.h"
24 #include "llvm/Target/TargetSubtargetInfo.h"
25 #include <string>
26
27 #define GET_SUBTARGETINFO_HEADER
28 #include "PPCGenSubtargetInfo.inc"
29
30 // GCC #defines PPC on Linux but we use it as our namespace name
31 #undef PPC
32
33 namespace llvm {
34 class StringRef;
35
36 namespace PPC {
37   // -m directive values.
38   enum {
39     DIR_NONE,
40     DIR_32,
41     DIR_440,
42     DIR_601,
43     DIR_602,
44     DIR_603,
45     DIR_7400,
46     DIR_750,
47     DIR_970,
48     DIR_A2,
49     DIR_E500mc,
50     DIR_E5500,
51     DIR_PWR3,
52     DIR_PWR4,
53     DIR_PWR5,
54     DIR_PWR5X,
55     DIR_PWR6,
56     DIR_PWR6X,
57     DIR_PWR7,
58     DIR_PWR8,
59     DIR_64
60   };
61 }
62
63 class GlobalValue;
64 class TargetMachine;
65
66 class PPCSubtarget : public PPCGenSubtargetInfo {
67 protected:
68   /// TargetTriple - What processor and OS we're targeting.
69   Triple TargetTriple;
70
71   /// stackAlignment - The minimum alignment known to hold of the stack frame on
72   /// entry to the function and which must be maintained by every function.
73   unsigned StackAlignment;
74
75   /// Selected instruction itineraries (one entry per itinerary class.)
76   InstrItineraryData InstrItins;
77
78   /// Which cpu directive was used.
79   unsigned DarwinDirective;
80
81   /// Used by the ISel to turn in optimizations for POWER4-derived architectures
82   bool HasMFOCRF;
83   bool Has64BitSupport;
84   bool Use64BitRegs;
85   bool UseCRBits;
86   bool IsPPC64;
87   bool HasAltivec;
88   bool HasSPE;
89   bool HasQPX;
90   bool HasVSX;
91   bool HasP8Vector;
92   bool HasP8Altivec;
93   bool HasP8Crypto;
94   bool HasFCPSGN;
95   bool HasFSQRT;
96   bool HasFRE, HasFRES, HasFRSQRTE, HasFRSQRTES;
97   bool HasRecipPrec;
98   bool HasSTFIWX;
99   bool HasLFIWAX;
100   bool HasFPRND;
101   bool HasFPCVT;
102   bool HasISEL;
103   bool HasPOPCNTD;
104   bool HasBPERMD;
105   bool HasExtDiv;
106   bool HasCMPB;
107   bool HasLDBRX;
108   bool IsBookE;
109   bool HasOnlyMSYNC;
110   bool IsE500;
111   bool IsPPC4xx;
112   bool IsPPC6xx;
113   bool DeprecatedMFTB;
114   bool DeprecatedDST;
115   bool HasLazyResolverStubs;
116   bool IsLittleEndian;
117   bool HasICBT;
118   bool HasInvariantFunctionDescriptors;
119   bool HasPartwordAtomics;
120   bool HasHTM;
121
122   /// When targeting QPX running a stock PPC64 Linux kernel where the stack
123   /// alignment has not been changed, we need to keep the 16-byte alignment
124   /// of the stack.
125   bool IsQPXStackUnaligned;
126
127   const PPCTargetMachine &TM;
128   PPCFrameLowering FrameLowering;
129   PPCInstrInfo InstrInfo;
130   PPCTargetLowering TLInfo;
131   PPCSelectionDAGInfo TSInfo;
132
133 public:
134   /// This constructor initializes the data members to match that
135   /// of the specified triple.
136   ///
137   PPCSubtarget(const std::string &TT, const std::string &CPU,
138                const std::string &FS, const PPCTargetMachine &TM);
139
140   /// ParseSubtargetFeatures - Parses features string setting specified
141   /// subtarget options.  Definition of function is auto generated by tblgen.
142   void ParseSubtargetFeatures(StringRef CPU, StringRef FS);
143
144   /// getStackAlignment - Returns the minimum alignment known to hold of the
145   /// stack frame on entry to the function and which must be maintained by every
146   /// function for this subtarget.
147   unsigned getStackAlignment() const { return StackAlignment; }
148
149   /// getDarwinDirective - Returns the -m directive specified for the cpu.
150   ///
151   unsigned getDarwinDirective() const { return DarwinDirective; }
152
153   /// getInstrItins - Return the instruction itineraries based on subtarget
154   /// selection.
155   const InstrItineraryData *getInstrItineraryData() const override {
156     return &InstrItins;
157   }
158
159   const PPCFrameLowering *getFrameLowering() const override {
160     return &FrameLowering;
161   }
162   const PPCInstrInfo *getInstrInfo() const override { return &InstrInfo; }
163   const PPCTargetLowering *getTargetLowering() const override {
164     return &TLInfo;
165   }
166   const PPCSelectionDAGInfo *getSelectionDAGInfo() const override {
167     return &TSInfo;
168   }
169   const PPCRegisterInfo *getRegisterInfo() const override {
170     return &getInstrInfo()->getRegisterInfo();
171   }
172   const PPCTargetMachine &getTargetMachine() const { return TM; }
173
174   /// initializeSubtargetDependencies - Initializes using a CPU and feature string
175   /// so that we can use initializer lists for subtarget initialization.
176   PPCSubtarget &initializeSubtargetDependencies(StringRef CPU, StringRef FS);
177
178 private:
179   void initializeEnvironment();
180   void initSubtargetFeatures(StringRef CPU, StringRef FS);
181
182 public:
183   /// isPPC64 - Return true if we are generating code for 64-bit pointer mode.
184   ///
185   bool isPPC64() const;
186
187   /// has64BitSupport - Return true if the selected CPU supports 64-bit
188   /// instructions, regardless of whether we are in 32-bit or 64-bit mode.
189   bool has64BitSupport() const { return Has64BitSupport; }
190
191   /// use64BitRegs - Return true if in 64-bit mode or if we should use 64-bit
192   /// registers in 32-bit mode when possible.  This can only true if
193   /// has64BitSupport() returns true.
194   bool use64BitRegs() const { return Use64BitRegs; }
195
196   /// useCRBits - Return true if we should store and manipulate i1 values in
197   /// the individual condition register bits.
198   bool useCRBits() const { return UseCRBits; }
199
200   /// hasLazyResolverStub - Return true if accesses to the specified global have
201   /// to go through a dyld lazy resolution stub.  This means that an extra load
202   /// is required to get the address of the global.
203   bool hasLazyResolverStub(const GlobalValue *GV) const;
204
205   // isLittleEndian - True if generating little-endian code
206   bool isLittleEndian() const { return IsLittleEndian; }
207
208   // Specific obvious features.
209   bool hasFCPSGN() const { return HasFCPSGN; }
210   bool hasFSQRT() const { return HasFSQRT; }
211   bool hasFRE() const { return HasFRE; }
212   bool hasFRES() const { return HasFRES; }
213   bool hasFRSQRTE() const { return HasFRSQRTE; }
214   bool hasFRSQRTES() const { return HasFRSQRTES; }
215   bool hasRecipPrec() const { return HasRecipPrec; }
216   bool hasSTFIWX() const { return HasSTFIWX; }
217   bool hasLFIWAX() const { return HasLFIWAX; }
218   bool hasFPRND() const { return HasFPRND; }
219   bool hasFPCVT() const { return HasFPCVT; }
220   bool hasAltivec() const { return HasAltivec; }
221   bool hasSPE() const { return HasSPE; }
222   bool hasQPX() const { return HasQPX; }
223   bool hasVSX() const { return HasVSX; }
224   bool hasP8Vector() const { return HasP8Vector; }
225   bool hasP8Altivec() const { return HasP8Altivec; }
226   bool hasP8Crypto() const { return HasP8Crypto; }
227   bool hasMFOCRF() const { return HasMFOCRF; }
228   bool hasISEL() const { return HasISEL; }
229   bool hasPOPCNTD() const { return HasPOPCNTD; }
230   bool hasBPERMD() const { return HasBPERMD; }
231   bool hasExtDiv() const { return HasExtDiv; }
232   bool hasCMPB() const { return HasCMPB; }
233   bool hasLDBRX() const { return HasLDBRX; }
234   bool isBookE() const { return IsBookE; }
235   bool hasOnlyMSYNC() const { return HasOnlyMSYNC; }
236   bool isPPC4xx() const { return IsPPC4xx; }
237   bool isPPC6xx() const { return IsPPC6xx; }
238   bool isE500() const { return IsE500; }
239   bool isDeprecatedMFTB() const { return DeprecatedMFTB; }
240   bool isDeprecatedDST() const { return DeprecatedDST; }
241   bool hasICBT() const { return HasICBT; }
242   bool hasInvariantFunctionDescriptors() const {
243     return HasInvariantFunctionDescriptors;
244   }
245   bool hasPartwordAtomics() const { return HasPartwordAtomics; }
246
247   bool isQPXStackUnaligned() const { return IsQPXStackUnaligned; }
248   unsigned getPlatformStackAlignment() const {
249     if ((hasQPX() || isBGQ()) && !isQPXStackUnaligned())
250       return 32;
251
252     return 16;
253   }
254   bool hasHTM() const { return HasHTM; }
255
256   const Triple &getTargetTriple() const { return TargetTriple; }
257
258   /// isDarwin - True if this is any darwin platform.
259   bool isDarwin() const { return TargetTriple.isMacOSX(); }
260   /// isBGQ - True if this is a BG/Q platform.
261   bool isBGQ() const { return TargetTriple.getVendor() == Triple::BGQ; }
262
263   bool isTargetELF() const { return TargetTriple.isOSBinFormatELF(); }
264   bool isTargetMachO() const { return TargetTriple.isOSBinFormatMachO(); }
265
266   bool isDarwinABI() const { return isTargetMachO() || isDarwin(); }
267   bool isSVR4ABI() const { return !isDarwinABI(); }
268   bool isELFv2ABI() const;
269
270   bool enableEarlyIfConversion() const override { return hasISEL(); }
271
272   // Scheduling customization.
273   bool enableMachineScheduler() const override;
274   // This overrides the PostRAScheduler bit in the SchedModel for each CPU.
275   bool enablePostMachineScheduler() const override;
276   AntiDepBreakMode getAntiDepBreakMode() const override;
277   void getCriticalPathRCs(RegClassVector &CriticalPathRCs) const override;
278
279   void overrideSchedPolicy(MachineSchedPolicy &Policy,
280                            MachineInstr *begin,
281                            MachineInstr *end,
282                            unsigned NumRegionInstrs) const override;
283   bool useAA() const override;
284
285   bool enableSubRegLiveness() const override;
286 };
287 } // End llvm namespace
288
289 #endif