xref: /freebsd/contrib/llvm-project/llvm/lib/Target/Mips/MipsSubtarget.h (revision 700637cbb5e582861067a11aaca4d053546871d2)
1 //===-- MipsSubtarget.h - Define Subtarget for the Mips ---------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file declares the Mips specific subclass of TargetSubtargetInfo.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_LIB_TARGET_MIPS_MIPSSUBTARGET_H
14 #define LLVM_LIB_TARGET_MIPS_MIPSSUBTARGET_H
15 
16 #include "MCTargetDesc/MipsABIInfo.h"
17 #include "MipsFrameLowering.h"
18 #include "MipsISelLowering.h"
19 #include "MipsInstrInfo.h"
20 #include "llvm/CodeGen/GlobalISel/CallLowering.h"
21 #include "llvm/CodeGen/GlobalISel/InstructionSelector.h"
22 #include "llvm/CodeGen/GlobalISel/LegalizerInfo.h"
23 #include "llvm/CodeGen/RegisterBankInfo.h"
24 #include "llvm/CodeGen/TargetSubtargetInfo.h"
25 #include "llvm/IR/DataLayout.h"
26 #include "llvm/MC/MCInstrItineraries.h"
27 #include "llvm/Support/ErrorHandling.h"
28 
29 #define GET_SUBTARGETINFO_HEADER
30 #include "MipsGenSubtargetInfo.inc"
31 
32 namespace llvm {
33 class StringRef;
34 
35 class MipsTargetMachine;
36 
37 class MipsSubtarget : public MipsGenSubtargetInfo {
38   virtual void anchor();
39 
40   enum MipsArchEnum {
41     MipsDefault,
42     Mips1, Mips2, Mips32, Mips32r2, Mips32r3, Mips32r5, Mips32r6, Mips32Max,
43     Mips3, Mips4, Mips5, Mips64, Mips64r2, Mips64r3, Mips64r5, Mips64r6
44   };
45 
46   enum class CPU { Others, P5600, I6400, I6500 };
47 
48   // Used to avoid printing dsp warnings multiple times.
49   static bool DspWarningPrinted;
50 
51   // Used to avoid printing msa warnings multiple times.
52   static bool MSAWarningPrinted;
53 
54   // Used to avoid printing crc warnings multiple times.
55   static bool CRCWarningPrinted;
56 
57   // Used to avoid printing ginv warnings multiple times.
58   static bool GINVWarningPrinted;
59 
60   // Used to avoid printing Mips1 warnings multiple times.
61   static bool MIPS1WarningPrinted;
62 
63   // Used to avoid printing virt warnings multiple times.
64   static bool VirtWarningPrinted;
65 
66   // Mips architecture version
67   MipsArchEnum MipsArchVersion;
68 
69   // Processor implementation
70   CPU ProcImpl = CPU::Others;
71 
72   // IsLittle - The target is Little Endian
73   bool IsLittle;
74 
75   // IsSoftFloat - The target does not support any floating point instructions.
76   bool IsSoftFloat;
77 
78   // IsSingleFloat - The target only supports single precision float
79   // point operations. This enable the target to use all 32 32-bit
80   // floating point registers instead of only using even ones.
81   bool IsSingleFloat;
82 
83   // IsFPXX - MIPS O32 modeless ABI.
84   bool IsFPXX;
85 
86   // NoABICalls - Disable SVR4-style position-independent code.
87   bool NoABICalls;
88 
89   // Abs2008 - Use IEEE 754-2008 abs.fmt instruction.
90   bool Abs2008;
91 
92   // IsFP64bit - The target processor has 64-bit floating point registers.
93   bool IsFP64bit;
94 
95   /// Are odd single-precision registers permitted?
96   /// This corresponds to -modd-spreg and -mno-odd-spreg
97   bool UseOddSPReg;
98 
99   // IsNan2008 - IEEE 754-2008 NaN encoding.
100   bool IsNaN2008bit;
101 
102   // IsGP64bit - General-purpose registers are 64 bits wide
103   bool IsGP64bit;
104 
105   // IsPTR64bit - Pointers are 64 bit wide
106   bool IsPTR64bit;
107 
108   // HasVFPU - Processor has a vector floating point unit.
109   bool HasVFPU;
110 
111   // CPU supports cnMIPS (Cavium Networks Octeon CPU).
112   bool HasCnMips;
113 
114   // CPU supports cnMIPSP (Cavium Networks Octeon+ CPU).
115   bool HasCnMipsP;
116 
117   // isLinux - Target system is Linux. Is false we consider ELFOS for now.
118   bool IsLinux;
119 
120   // UseSmallSection - Small section is used.
121   bool UseSmallSection;
122 
123   /// Features related to the presence of specific instructions.
124 
125   // HasMips3_32 - The subset of MIPS-III instructions added to MIPS32
126   bool HasMips3_32;
127 
128   // HasMips3_32r2 - The subset of MIPS-III instructions added to MIPS32r2
129   bool HasMips3_32r2;
130 
131   // HasMips4_32 - Has the subset of MIPS-IV present in MIPS32
132   bool HasMips4_32;
133 
134   // HasMips4_32r2 - Has the subset of MIPS-IV present in MIPS32r2
135   bool HasMips4_32r2;
136 
137   // HasMips5_32r2 - Has the subset of MIPS-V present in MIPS32r2
138   bool HasMips5_32r2;
139 
140   // InMips16 -- can process Mips16 instructions
141   bool InMips16Mode;
142 
143   // Mips16 hard float
144   bool InMips16HardFloat;
145 
146   // InMicroMips -- can process MicroMips instructions
147   bool InMicroMipsMode;
148 
149   // HasDSP, HasDSPR2, HasDSPR3 -- supports DSP ASE.
150   bool HasDSP, HasDSPR2, HasDSPR3;
151 
152   // Has3D -- Supports Mips3D ASE.
153   bool Has3D;
154 
155   // Allow mixed Mips16 and Mips32 in one source file
156   bool AllowMixed16_32;
157 
158   // Optimize for space by compiling all functions as Mips 16 unless
159   // it needs floating point. Functions needing floating point are
160   // compiled as Mips32
161   bool Os16;
162 
163   // HasMSA -- supports MSA ASE.
164   bool HasMSA;
165 
166   // UseTCCInDIV -- Enables the use of trapping in the assembler.
167   bool UseTCCInDIV;
168 
169   // Sym32 -- On Mips64 symbols are 32 bits.
170   bool HasSym32;
171 
172   // HasEVA -- supports EVA ASE.
173   bool HasEVA;
174 
175   // nomadd4 - disables generation of 4-operand madd.s, madd.d and
176   // related instructions.
177   bool DisableMadd4;
178 
179   // HasMT -- support MT ASE.
180   bool HasMT;
181 
182   // HasCRC -- supports R6 CRC ASE
183   bool HasCRC;
184 
185   // HasVirt -- supports Virtualization ASE
186   bool HasVirt;
187 
188   // HasGINV -- supports R6 Global INValidate ASE
189   bool HasGINV;
190 
191   // Use hazard variants of the jump register instructions for indirect
192   // function calls and jump tables.
193   bool UseIndirectJumpsHazard;
194 
195   // Disable use of the `jal` instruction.
196   bool UseLongCalls = false;
197 
198   // Assume 32-bit GOT.
199   bool UseXGOT = false;
200 
201   // Disable unaligned load store for r6.
202   bool StrictAlign;
203 
204   /// The minimum alignment known to hold of the stack frame on
205   /// entry to the function and which must be maintained by every function.
206   Align stackAlignment;
207 
208   /// The overridden stack alignment.
209   MaybeAlign StackAlignOverride;
210 
211   InstrItineraryData InstrItins;
212 
213   // We can override the determination of whether we are in mips16 mode
214   // as from the command line
215   enum {NoOverride, Mips16Override, NoMips16Override} OverrideMode;
216 
217   const MipsTargetMachine &TM;
218 
219   Triple TargetTriple;
220 
221   std::unique_ptr<const SelectionDAGTargetInfo> TSInfo;
222   std::unique_ptr<const MipsInstrInfo> InstrInfo;
223   std::unique_ptr<const MipsFrameLowering> FrameLowering;
224   std::unique_ptr<const MipsTargetLowering> TLInfo;
225 
226 public:
227   bool isPositionIndependent() const;
228   /// This overrides the PostRAScheduler bit in the SchedModel for each CPU.
229   bool enablePostRAScheduler() const override;
230   void getCriticalPathRCs(RegClassVector &CriticalPathRCs) const override;
231   CodeGenOptLevel getOptLevelToEnablePostRAScheduler() const override;
232 
233   bool isABI_N64() const;
234   bool isABI_N32() const;
235   bool isABI_O32() const;
236   const MipsABIInfo &getABI() const;
isABI_FPXX()237   bool isABI_FPXX() const { return isABI_O32() && IsFPXX; }
238 
239   /// This constructor initializes the data members to match that
240   /// of the specified triple.
241   MipsSubtarget(const Triple &TT, StringRef CPU, StringRef FS, bool little,
242                 const MipsTargetMachine &TM, MaybeAlign StackAlignOverride);
243 
244   ~MipsSubtarget() override;
245 
246   /// ParseSubtargetFeatures - Parses features string setting specified
247   /// subtarget options.  Definition of function is auto generated by tblgen.
248   void ParseSubtargetFeatures(StringRef CPU, StringRef TuneCPU, StringRef FS);
249 
hasMips1()250   bool hasMips1() const { return MipsArchVersion >= Mips1; }
hasMips2()251   bool hasMips2() const { return MipsArchVersion >= Mips2; }
hasMips3()252   bool hasMips3() const { return MipsArchVersion >= Mips3; }
hasMips4()253   bool hasMips4() const { return MipsArchVersion >= Mips4; }
hasMips5()254   bool hasMips5() const { return MipsArchVersion >= Mips5; }
hasMips4_32()255   bool hasMips4_32() const { return HasMips4_32; }
hasMips4_32r2()256   bool hasMips4_32r2() const { return HasMips4_32r2; }
hasMips32()257   bool hasMips32() const {
258     return (MipsArchVersion >= Mips32 && MipsArchVersion < Mips32Max) ||
259            hasMips64();
260   }
hasMips32r2()261   bool hasMips32r2() const {
262     return (MipsArchVersion >= Mips32r2 && MipsArchVersion < Mips32Max) ||
263            hasMips64r2();
264   }
hasMips32r3()265   bool hasMips32r3() const {
266     return (MipsArchVersion >= Mips32r3 && MipsArchVersion < Mips32Max) ||
267            hasMips64r2();
268   }
hasMips32r5()269   bool hasMips32r5() const {
270     return (MipsArchVersion >= Mips32r5 && MipsArchVersion < Mips32Max) ||
271            hasMips64r5();
272   }
hasMips32r6()273   bool hasMips32r6() const {
274     return (MipsArchVersion >= Mips32r6 && MipsArchVersion < Mips32Max) ||
275            hasMips64r6();
276   }
hasMips64()277   bool hasMips64() const { return MipsArchVersion >= Mips64; }
hasMips64r2()278   bool hasMips64r2() const { return MipsArchVersion >= Mips64r2; }
hasMips64r3()279   bool hasMips64r3() const { return MipsArchVersion >= Mips64r3; }
hasMips64r5()280   bool hasMips64r5() const { return MipsArchVersion >= Mips64r5; }
hasMips64r6()281   bool hasMips64r6() const { return MipsArchVersion >= Mips64r6; }
282 
hasCnMips()283   bool hasCnMips() const { return HasCnMips; }
hasCnMipsP()284   bool hasCnMipsP() const { return HasCnMipsP; }
285 
isLittle()286   bool isLittle() const { return IsLittle; }
isABICalls()287   bool isABICalls() const { return !NoABICalls; }
isFPXX()288   bool isFPXX() const { return IsFPXX; }
isFP64bit()289   bool isFP64bit() const { return IsFP64bit; }
useOddSPReg()290   bool useOddSPReg() const { return UseOddSPReg; }
noOddSPReg()291   bool noOddSPReg() const { return !UseOddSPReg; }
isNaN2008()292   bool isNaN2008() const { return IsNaN2008bit; }
inAbs2008Mode()293   bool inAbs2008Mode() const { return Abs2008; }
isGP64bit()294   bool isGP64bit() const { return IsGP64bit; }
isGP32bit()295   bool isGP32bit() const { return !IsGP64bit; }
getGPRSizeInBytes()296   unsigned getGPRSizeInBytes() const { return isGP64bit() ? 8 : 4; }
isPTR64bit()297   bool isPTR64bit() const { return IsPTR64bit; }
isPTR32bit()298   bool isPTR32bit() const { return !IsPTR64bit; }
hasSym32()299   bool hasSym32() const {
300     return (HasSym32 && isABI_N64()) || isABI_N32() || isABI_O32();
301   }
isSingleFloat()302   bool isSingleFloat() const { return IsSingleFloat; }
isTargetCOFF()303   bool isTargetCOFF() const { return TargetTriple.isOSBinFormatCOFF(); }
isTargetELF()304   bool isTargetELF() const { return TargetTriple.isOSBinFormatELF(); }
hasVFPU()305   bool hasVFPU() const { return HasVFPU; }
inMips16Mode()306   bool inMips16Mode() const { return InMips16Mode; }
inMips16ModeDefault()307   bool inMips16ModeDefault() const {
308     return InMips16Mode;
309   }
310   // Hard float for mips16 means essentially to compile as soft float
311   // but to use a runtime library for soft float that is written with
312   // native mips32 floating point instructions (those runtime routines
313   // run in mips32 hard float mode).
inMips16HardFloat()314   bool inMips16HardFloat() const {
315     return inMips16Mode() && InMips16HardFloat;
316   }
inMicroMipsMode()317   bool inMicroMipsMode() const { return InMicroMipsMode && !InMips16Mode; }
inMicroMips32r6Mode()318   bool inMicroMips32r6Mode() const {
319     return inMicroMipsMode() && hasMips32r6();
320   }
hasDSP()321   bool hasDSP() const { return HasDSP; }
hasDSPR2()322   bool hasDSPR2() const { return HasDSPR2; }
hasDSPR3()323   bool hasDSPR3() const { return HasDSPR3; }
has3D()324   bool has3D() const { return Has3D; }
hasMSA()325   bool hasMSA() const { return HasMSA; }
disableMadd4()326   bool disableMadd4() const { return DisableMadd4; }
hasEVA()327   bool hasEVA() const { return HasEVA; }
hasMT()328   bool hasMT() const { return HasMT; }
hasCRC()329   bool hasCRC() const { return HasCRC; }
hasVirt()330   bool hasVirt() const { return HasVirt; }
hasGINV()331   bool hasGINV() const { return HasGINV; }
useIndirectJumpsHazard()332   bool useIndirectJumpsHazard() const {
333     return UseIndirectJumpsHazard && hasMips32r2();
334   }
useSmallSection()335   bool useSmallSection() const { return UseSmallSection; }
336 
hasStandardEncoding()337   bool hasStandardEncoding() const { return !InMips16Mode && !InMicroMipsMode; }
338 
useSoftFloat()339   bool useSoftFloat() const { return IsSoftFloat; }
340 
useLongCalls()341   bool useLongCalls() const { return UseLongCalls; }
342 
useXGOT()343   bool useXGOT() const { return UseXGOT; }
344 
enableLongBranchPass()345   bool enableLongBranchPass() const {
346     return hasStandardEncoding() || inMicroMipsMode() || allowMixed16_32();
347   }
348 
349   /// Features related to the presence of specific instructions.
hasExtractInsert()350   bool hasExtractInsert() const { return !inMips16Mode() && hasMips32r2(); }
hasMTHC1()351   bool hasMTHC1() const { return hasMips32r2(); }
352 
allowMixed16_32()353   bool allowMixed16_32() const { return inMips16ModeDefault() |
354                                         AllowMixed16_32; }
355 
os16()356   bool os16() const { return Os16; }
357 
isTargetNaCl()358   bool isTargetNaCl() const { return TargetTriple.isOSNaCl(); }
isTargetWindows()359   bool isTargetWindows() const { return TargetTriple.isOSWindows(); }
360 
isXRaySupported()361   bool isXRaySupported() const override { return true; }
362 
363   // for now constant islands are on for the whole compilation unit but we only
364   // really use them if in addition we are in mips16 mode
365   static bool useConstantIslands();
366 
getStackAlignment()367   Align getStackAlignment() const { return stackAlignment; }
368 
369   // Grab relocation model
370   Reloc::Model getRelocationModel() const;
371 
372   MipsSubtarget &initializeSubtargetDependencies(StringRef CPU, StringRef FS,
373                                                  const TargetMachine &TM);
374 
375   /// Does the system support unaligned memory access.
376   ///
377   /// MIPS32r6/MIPS64r6 require full unaligned access support but does not
378   /// specify which component of the system provides it. Hardware, software, and
379   /// hybrid implementations are all valid.
systemSupportsUnalignedAccess()380   bool systemSupportsUnalignedAccess() const {
381     return hasMips32r6() && !StrictAlign;
382   }
383 
384   // Set helper classes
385   void setHelperClassesMips16();
386   void setHelperClassesMipsSE();
387 
388   const SelectionDAGTargetInfo *getSelectionDAGInfo() const override;
389 
getInstrInfo()390   const MipsInstrInfo *getInstrInfo() const override { return InstrInfo.get(); }
getFrameLowering()391   const TargetFrameLowering *getFrameLowering() const override {
392     return FrameLowering.get();
393   }
getRegisterInfo()394   const MipsRegisterInfo *getRegisterInfo() const override {
395     return &InstrInfo->getRegisterInfo();
396   }
getTargetLowering()397   const MipsTargetLowering *getTargetLowering() const override {
398     return TLInfo.get();
399   }
getInstrItineraryData()400   const InstrItineraryData *getInstrItineraryData() const override {
401     return &InstrItins;
402   }
403 
404 protected:
405   // GlobalISel related APIs.
406   std::unique_ptr<CallLowering> CallLoweringInfo;
407   std::unique_ptr<LegalizerInfo> Legalizer;
408   std::unique_ptr<RegisterBankInfo> RegBankInfo;
409   std::unique_ptr<InstructionSelector> InstSelector;
410 
411 public:
412   const CallLowering *getCallLowering() const override;
413   const LegalizerInfo *getLegalizerInfo() const override;
414   const RegisterBankInfo *getRegBankInfo() const override;
415   InstructionSelector *getInstructionSelector() const override;
416 };
417 } // End llvm namespace
418 
419 #endif
420