ARM: allow copying of CPSR when all else fails.
[oota-llvm.git] / lib / Target / ARM / ARMBaseInstrInfo.h
1 //===-- ARMBaseInstrInfo.h - ARM Base Instruction Information ---*- 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 contains the Base ARM implementation of the TargetInstrInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_LIB_TARGET_ARM_ARMBASEINSTRINFO_H
15 #define LLVM_LIB_TARGET_ARM_ARMBASEINSTRINFO_H
16
17 #include "MCTargetDesc/ARMBaseInfo.h"
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/SmallSet.h"
20 #include "llvm/CodeGen/MachineInstrBuilder.h"
21 #include "llvm/Support/CodeGen.h"
22 #include "llvm/Target/TargetInstrInfo.h"
23
24 #define GET_INSTRINFO_HEADER
25 #include "ARMGenInstrInfo.inc"
26
27 namespace llvm {
28   class ARMSubtarget;
29   class ARMBaseRegisterInfo;
30
31 class ARMBaseInstrInfo : public ARMGenInstrInfo {
32   const ARMSubtarget &Subtarget;
33
34 protected:
35   // Can be only subclassed.
36   explicit ARMBaseInstrInfo(const ARMSubtarget &STI);
37
38   void expandLoadStackGuardBase(MachineBasicBlock::iterator MI,
39                                 unsigned LoadImmOpc, unsigned LoadOpc,
40                                 Reloc::Model RM) const;
41
42   /// Build the equivalent inputs of a REG_SEQUENCE for the given \p MI
43   /// and \p DefIdx.
44   /// \p [out] InputRegs of the equivalent REG_SEQUENCE. Each element of
45   /// the list is modeled as <Reg:SubReg, SubIdx>.
46   /// E.g., REG_SEQUENCE vreg1:sub1, sub0, vreg2, sub1 would produce
47   /// two elements:
48   /// - vreg1:sub1, sub0
49   /// - vreg2<:0>, sub1
50   ///
51   /// \returns true if it is possible to build such an input sequence
52   /// with the pair \p MI, \p DefIdx. False otherwise.
53   ///
54   /// \pre MI.isRegSequenceLike().
55   bool getRegSequenceLikeInputs(
56       const MachineInstr &MI, unsigned DefIdx,
57       SmallVectorImpl<RegSubRegPairAndIdx> &InputRegs) const override;
58
59   /// Build the equivalent inputs of a EXTRACT_SUBREG for the given \p MI
60   /// and \p DefIdx.
61   /// \p [out] InputReg of the equivalent EXTRACT_SUBREG.
62   /// E.g., EXTRACT_SUBREG vreg1:sub1, sub0, sub1 would produce:
63   /// - vreg1:sub1, sub0
64   ///
65   /// \returns true if it is possible to build such an input sequence
66   /// with the pair \p MI, \p DefIdx. False otherwise.
67   ///
68   /// \pre MI.isExtractSubregLike().
69   bool getExtractSubregLikeInputs(const MachineInstr &MI, unsigned DefIdx,
70                                   RegSubRegPairAndIdx &InputReg) const override;
71
72   /// Build the equivalent inputs of a INSERT_SUBREG for the given \p MI
73   /// and \p DefIdx.
74   /// \p [out] BaseReg and \p [out] InsertedReg contain
75   /// the equivalent inputs of INSERT_SUBREG.
76   /// E.g., INSERT_SUBREG vreg0:sub0, vreg1:sub1, sub3 would produce:
77   /// - BaseReg: vreg0:sub0
78   /// - InsertedReg: vreg1:sub1, sub3
79   ///
80   /// \returns true if it is possible to build such an input sequence
81   /// with the pair \p MI, \p DefIdx. False otherwise.
82   ///
83   /// \pre MI.isInsertSubregLike().
84   bool
85   getInsertSubregLikeInputs(const MachineInstr &MI, unsigned DefIdx,
86                             RegSubRegPair &BaseReg,
87                             RegSubRegPairAndIdx &InsertedReg) const override;
88
89 public:
90   // Return whether the target has an explicit NOP encoding.
91   bool hasNOP() const;
92
93   // Return the non-pre/post incrementing version of 'Opc'. Return 0
94   // if there is not such an opcode.
95   virtual unsigned getUnindexedOpcode(unsigned Opc) const =0;
96
97   MachineInstr *convertToThreeAddress(MachineFunction::iterator &MFI,
98                                       MachineBasicBlock::iterator &MBBI,
99                                       LiveVariables *LV) const override;
100
101   virtual const ARMBaseRegisterInfo &getRegisterInfo() const = 0;
102   const ARMSubtarget &getSubtarget() const { return Subtarget; }
103
104   ScheduleHazardRecognizer *
105   CreateTargetHazardRecognizer(const TargetSubtargetInfo *STI,
106                                const ScheduleDAG *DAG) const override;
107
108   ScheduleHazardRecognizer *
109   CreateTargetPostRAHazardRecognizer(const InstrItineraryData *II,
110                                      const ScheduleDAG *DAG) const override;
111
112   // Branch analysis.
113   bool AnalyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
114                      MachineBasicBlock *&FBB,
115                      SmallVectorImpl<MachineOperand> &Cond,
116                      bool AllowModify = false) const override;
117   unsigned RemoveBranch(MachineBasicBlock &MBB) const override;
118   unsigned InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
119                         MachineBasicBlock *FBB,
120                         const SmallVectorImpl<MachineOperand> &Cond,
121                         DebugLoc DL) const override;
122
123   bool
124   ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const override;
125
126   // Predication support.
127   bool isPredicated(const MachineInstr *MI) const override;
128
129   ARMCC::CondCodes getPredicate(const MachineInstr *MI) const {
130     int PIdx = MI->findFirstPredOperandIdx();
131     return PIdx != -1 ? (ARMCC::CondCodes)MI->getOperand(PIdx).getImm()
132                       : ARMCC::AL;
133   }
134
135   bool PredicateInstruction(MachineInstr *MI,
136                     const SmallVectorImpl<MachineOperand> &Pred) const override;
137
138   bool SubsumesPredicate(const SmallVectorImpl<MachineOperand> &Pred1,
139                    const SmallVectorImpl<MachineOperand> &Pred2) const override;
140
141   bool DefinesPredicate(MachineInstr *MI,
142                         std::vector<MachineOperand> &Pred) const override;
143
144   bool isPredicable(MachineInstr *MI) const override;
145
146   /// GetInstSize - Returns the size of the specified MachineInstr.
147   ///
148   virtual unsigned GetInstSizeInBytes(const MachineInstr* MI) const;
149
150   unsigned isLoadFromStackSlot(const MachineInstr *MI,
151                                int &FrameIndex) const override;
152   unsigned isStoreToStackSlot(const MachineInstr *MI,
153                               int &FrameIndex) const override;
154   unsigned isLoadFromStackSlotPostFE(const MachineInstr *MI,
155                                      int &FrameIndex) const override;
156   unsigned isStoreToStackSlotPostFE(const MachineInstr *MI,
157                                     int &FrameIndex) const override;
158
159   void copyToCPSR(MachineBasicBlock &MBB, MachineBasicBlock::iterator I,
160                   unsigned SrcReg, bool KillSrc,
161                   const ARMSubtarget &Subtarget) const;
162   void copyFromCPSR(MachineBasicBlock &MBB, MachineBasicBlock::iterator I,
163                     unsigned DestReg, bool KillSrc,
164                     const ARMSubtarget &Subtarget) const;
165
166   void copyPhysReg(MachineBasicBlock &MBB, MachineBasicBlock::iterator I,
167                    DebugLoc DL, unsigned DestReg, unsigned SrcReg,
168                    bool KillSrc) const override;
169
170   void storeRegToStackSlot(MachineBasicBlock &MBB,
171                            MachineBasicBlock::iterator MBBI,
172                            unsigned SrcReg, bool isKill, int FrameIndex,
173                            const TargetRegisterClass *RC,
174                            const TargetRegisterInfo *TRI) const override;
175
176   void loadRegFromStackSlot(MachineBasicBlock &MBB,
177                             MachineBasicBlock::iterator MBBI,
178                             unsigned DestReg, int FrameIndex,
179                             const TargetRegisterClass *RC,
180                             const TargetRegisterInfo *TRI) const override;
181
182   bool expandPostRAPseudo(MachineBasicBlock::iterator MI) const override;
183
184   void reMaterialize(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
185                      unsigned DestReg, unsigned SubIdx,
186                      const MachineInstr *Orig,
187                      const TargetRegisterInfo &TRI) const override;
188
189   MachineInstr *duplicate(MachineInstr *Orig,
190                           MachineFunction &MF) const override;
191
192   MachineInstr *commuteInstruction(MachineInstr*,
193                                    bool=false) const override;
194
195   const MachineInstrBuilder &AddDReg(MachineInstrBuilder &MIB, unsigned Reg,
196                                      unsigned SubIdx, unsigned State,
197                                      const TargetRegisterInfo *TRI) const;
198
199   bool produceSameValue(const MachineInstr *MI0, const MachineInstr *MI1,
200                         const MachineRegisterInfo *MRI) const override;
201
202   /// areLoadsFromSameBasePtr - This is used by the pre-regalloc scheduler to
203   /// determine if two loads are loading from the same base address. It should
204   /// only return true if the base pointers are the same and the only
205   /// differences between the two addresses is the offset. It also returns the
206   /// offsets by reference.
207   bool areLoadsFromSameBasePtr(SDNode *Load1, SDNode *Load2, int64_t &Offset1,
208                                int64_t &Offset2) const override;
209
210   /// shouldScheduleLoadsNear - This is a used by the pre-regalloc scheduler to
211   /// determine (in conjunction with areLoadsFromSameBasePtr) if two loads
212   /// should be scheduled togther. On some targets if two loads are loading from
213   /// addresses in the same cache line, it's better if they are scheduled
214   /// together. This function takes two integers that represent the load offsets
215   /// from the common base address. It returns true if it decides it's desirable
216   /// to schedule the two loads together. "NumLoads" is the number of loads that
217   /// have already been scheduled after Load1.
218   bool shouldScheduleLoadsNear(SDNode *Load1, SDNode *Load2,
219                                int64_t Offset1, int64_t Offset2,
220                                unsigned NumLoads) const override;
221
222   bool isSchedulingBoundary(const MachineInstr *MI,
223                             const MachineBasicBlock *MBB,
224                             const MachineFunction &MF) const override;
225
226   bool isProfitableToIfCvt(MachineBasicBlock &MBB,
227                            unsigned NumCycles, unsigned ExtraPredCycles,
228                            const BranchProbability &Probability) const override;
229
230   bool isProfitableToIfCvt(MachineBasicBlock &TMBB, unsigned NumT,
231                            unsigned ExtraT, MachineBasicBlock &FMBB,
232                            unsigned NumF, unsigned ExtraF,
233                            const BranchProbability &Probability) const override;
234
235   bool isProfitableToDupForIfCvt(MachineBasicBlock &MBB, unsigned NumCycles,
236                           const BranchProbability &Probability) const override {
237     return NumCycles == 1;
238   }
239
240   bool isProfitableToUnpredicate(MachineBasicBlock &TMBB,
241                                  MachineBasicBlock &FMBB) const override;
242
243   /// analyzeCompare - For a comparison instruction, return the source registers
244   /// in SrcReg and SrcReg2 if having two register operands, and the value it
245   /// compares against in CmpValue. Return true if the comparison instruction
246   /// can be analyzed.
247   bool analyzeCompare(const MachineInstr *MI, unsigned &SrcReg,
248                       unsigned &SrcReg2, int &CmpMask,
249                       int &CmpValue) const override;
250
251   /// optimizeCompareInstr - Convert the instruction to set the zero flag so
252   /// that we can remove a "comparison with zero"; Remove a redundant CMP
253   /// instruction if the flags can be updated in the same way by an earlier
254   /// instruction such as SUB.
255   bool optimizeCompareInstr(MachineInstr *CmpInstr, unsigned SrcReg,
256                             unsigned SrcReg2, int CmpMask, int CmpValue,
257                             const MachineRegisterInfo *MRI) const override;
258
259   bool analyzeSelect(const MachineInstr *MI,
260                      SmallVectorImpl<MachineOperand> &Cond,
261                      unsigned &TrueOp, unsigned &FalseOp,
262                      bool &Optimizable) const override;
263
264   MachineInstr *optimizeSelect(MachineInstr *MI, bool) const override;
265
266   /// FoldImmediate - 'Reg' is known to be defined by a move immediate
267   /// instruction, try to fold the immediate into the use instruction.
268   bool FoldImmediate(MachineInstr *UseMI, MachineInstr *DefMI,
269                      unsigned Reg, MachineRegisterInfo *MRI) const override;
270
271   unsigned getNumMicroOps(const InstrItineraryData *ItinData,
272                           const MachineInstr *MI) const override;
273
274   int getOperandLatency(const InstrItineraryData *ItinData,
275                         const MachineInstr *DefMI, unsigned DefIdx,
276                         const MachineInstr *UseMI,
277                         unsigned UseIdx) const override;
278   int getOperandLatency(const InstrItineraryData *ItinData,
279                         SDNode *DefNode, unsigned DefIdx,
280                         SDNode *UseNode, unsigned UseIdx) const override;
281
282   /// VFP/NEON execution domains.
283   std::pair<uint16_t, uint16_t>
284   getExecutionDomain(const MachineInstr *MI) const override;
285   void setExecutionDomain(MachineInstr *MI, unsigned Domain) const override;
286
287   unsigned getPartialRegUpdateClearance(const MachineInstr*, unsigned,
288                                       const TargetRegisterInfo*) const override;
289   void breakPartialRegDependency(MachineBasicBlock::iterator, unsigned,
290                                  const TargetRegisterInfo *TRI) const override;
291
292   void
293   getUnconditionalBranch(MCInst &Branch,
294                          const MCSymbolRefExpr *BranchTarget) const override;
295
296   void getTrap(MCInst &MI) const override;
297
298   /// Get the number of addresses by LDM or VLDM or zero for unknown.
299   unsigned getNumLDMAddresses(const MachineInstr *MI) const;
300
301 private:
302   unsigned getInstBundleLength(const MachineInstr *MI) const;
303
304   int getVLDMDefCycle(const InstrItineraryData *ItinData,
305                       const MCInstrDesc &DefMCID,
306                       unsigned DefClass,
307                       unsigned DefIdx, unsigned DefAlign) const;
308   int getLDMDefCycle(const InstrItineraryData *ItinData,
309                      const MCInstrDesc &DefMCID,
310                      unsigned DefClass,
311                      unsigned DefIdx, unsigned DefAlign) const;
312   int getVSTMUseCycle(const InstrItineraryData *ItinData,
313                       const MCInstrDesc &UseMCID,
314                       unsigned UseClass,
315                       unsigned UseIdx, unsigned UseAlign) const;
316   int getSTMUseCycle(const InstrItineraryData *ItinData,
317                      const MCInstrDesc &UseMCID,
318                      unsigned UseClass,
319                      unsigned UseIdx, unsigned UseAlign) const;
320   int getOperandLatency(const InstrItineraryData *ItinData,
321                         const MCInstrDesc &DefMCID,
322                         unsigned DefIdx, unsigned DefAlign,
323                         const MCInstrDesc &UseMCID,
324                         unsigned UseIdx, unsigned UseAlign) const;
325
326   unsigned getPredicationCost(const MachineInstr *MI) const override;
327
328   unsigned getInstrLatency(const InstrItineraryData *ItinData,
329                            const MachineInstr *MI,
330                            unsigned *PredCost = nullptr) const override;
331
332   int getInstrLatency(const InstrItineraryData *ItinData,
333                       SDNode *Node) const override;
334
335   bool hasHighOperandLatency(const InstrItineraryData *ItinData,
336                              const MachineRegisterInfo *MRI,
337                              const MachineInstr *DefMI, unsigned DefIdx,
338                              const MachineInstr *UseMI,
339                              unsigned UseIdx) const override;
340   bool hasLowDefLatency(const InstrItineraryData *ItinData,
341                         const MachineInstr *DefMI,
342                         unsigned DefIdx) const override;
343
344   /// verifyInstruction - Perform target specific instruction verification.
345   bool verifyInstruction(const MachineInstr *MI,
346                          StringRef &ErrInfo) const override;
347
348   virtual void expandLoadStackGuard(MachineBasicBlock::iterator MI,
349                                     Reloc::Model RM) const = 0;
350
351 private:
352   /// Modeling special VFP / NEON fp MLA / MLS hazards.
353
354   /// MLxEntryMap - Map fp MLA / MLS to the corresponding entry in the internal
355   /// MLx table.
356   DenseMap<unsigned, unsigned> MLxEntryMap;
357
358   /// MLxHazardOpcodes - Set of add / sub and multiply opcodes that would cause
359   /// stalls when scheduled together with fp MLA / MLS opcodes.
360   SmallSet<unsigned, 16> MLxHazardOpcodes;
361
362 public:
363   /// isFpMLxInstruction - Return true if the specified opcode is a fp MLA / MLS
364   /// instruction.
365   bool isFpMLxInstruction(unsigned Opcode) const {
366     return MLxEntryMap.count(Opcode);
367   }
368
369   /// isFpMLxInstruction - This version also returns the multiply opcode and the
370   /// addition / subtraction opcode to expand to. Return true for 'HasLane' for
371   /// the MLX instructions with an extra lane operand.
372   bool isFpMLxInstruction(unsigned Opcode, unsigned &MulOpc,
373                           unsigned &AddSubOpc, bool &NegAcc,
374                           bool &HasLane) const;
375
376   /// canCauseFpMLxStall - Return true if an instruction of the specified opcode
377   /// will cause stalls when scheduled after (within 4-cycle window) a fp
378   /// MLA / MLS instruction.
379   bool canCauseFpMLxStall(unsigned Opcode) const {
380     return MLxHazardOpcodes.count(Opcode);
381   }
382
383   /// Returns true if the instruction has a shift by immediate that can be
384   /// executed in one cycle less.
385   bool isSwiftFastImmShift(const MachineInstr *MI) const;
386 };
387
388 static inline
389 const MachineInstrBuilder &AddDefaultPred(const MachineInstrBuilder &MIB) {
390   return MIB.addImm((int64_t)ARMCC::AL).addReg(0);
391 }
392
393 static inline
394 const MachineInstrBuilder &AddDefaultCC(const MachineInstrBuilder &MIB) {
395   return MIB.addReg(0);
396 }
397
398 static inline
399 const MachineInstrBuilder &AddDefaultT1CC(const MachineInstrBuilder &MIB,
400                                           bool isDead = false) {
401   return MIB.addReg(ARM::CPSR, getDefRegState(true) | getDeadRegState(isDead));
402 }
403
404 static inline
405 const MachineInstrBuilder &AddNoT1CC(const MachineInstrBuilder &MIB) {
406   return MIB.addReg(0);
407 }
408
409 static inline
410 bool isUncondBranchOpcode(int Opc) {
411   return Opc == ARM::B || Opc == ARM::tB || Opc == ARM::t2B;
412 }
413
414 static inline
415 bool isCondBranchOpcode(int Opc) {
416   return Opc == ARM::Bcc || Opc == ARM::tBcc || Opc == ARM::t2Bcc;
417 }
418
419 static inline
420 bool isJumpTableBranchOpcode(int Opc) {
421   return Opc == ARM::BR_JTr || Opc == ARM::BR_JTm || Opc == ARM::BR_JTadd ||
422     Opc == ARM::tBR_JTr || Opc == ARM::t2BR_JT;
423 }
424
425 static inline
426 bool isIndirectBranchOpcode(int Opc) {
427   return Opc == ARM::BX || Opc == ARM::MOVPCRX || Opc == ARM::tBRIND;
428 }
429
430 static inline bool isPopOpcode(int Opc) {
431   return Opc == ARM::tPOP_RET || Opc == ARM::LDMIA_RET ||
432          Opc == ARM::t2LDMIA_RET || Opc == ARM::tPOP || Opc == ARM::LDMIA_UPD ||
433          Opc == ARM::t2LDMIA_UPD || Opc == ARM::VLDMDIA_UPD;
434 }
435
436 static inline bool isPushOpcode(int Opc) {
437   return Opc == ARM::tPUSH || Opc == ARM::t2STMDB_UPD ||
438          Opc == ARM::STMDB_UPD || Opc == ARM::VSTMDDB_UPD;
439 }
440
441 /// getInstrPredicate - If instruction is predicated, returns its predicate
442 /// condition, otherwise returns AL. It also returns the condition code
443 /// register by reference.
444 ARMCC::CondCodes getInstrPredicate(const MachineInstr *MI, unsigned &PredReg);
445
446 int getMatchingCondBranchOpcode(int Opc);
447
448 /// Determine if MI can be folded into an ARM MOVCC instruction, and return the
449 /// opcode of the SSA instruction representing the conditional MI.
450 unsigned canFoldARMInstrIntoMOVCC(unsigned Reg,
451                                   MachineInstr *&MI,
452                                   const MachineRegisterInfo &MRI);
453
454 /// Map pseudo instructions that imply an 'S' bit onto real opcodes. Whether
455 /// the instruction is encoded with an 'S' bit is determined by the optional
456 /// CPSR def operand.
457 unsigned convertAddSubFlagsOpcode(unsigned OldOpc);
458
459 /// emitARMRegPlusImmediate / emitT2RegPlusImmediate - Emits a series of
460 /// instructions to materializea destreg = basereg + immediate in ARM / Thumb2
461 /// code.
462 void emitARMRegPlusImmediate(MachineBasicBlock &MBB,
463                              MachineBasicBlock::iterator &MBBI, DebugLoc dl,
464                              unsigned DestReg, unsigned BaseReg, int NumBytes,
465                              ARMCC::CondCodes Pred, unsigned PredReg,
466                              const ARMBaseInstrInfo &TII, unsigned MIFlags = 0);
467
468 void emitT2RegPlusImmediate(MachineBasicBlock &MBB,
469                             MachineBasicBlock::iterator &MBBI, DebugLoc dl,
470                             unsigned DestReg, unsigned BaseReg, int NumBytes,
471                             ARMCC::CondCodes Pred, unsigned PredReg,
472                             const ARMBaseInstrInfo &TII, unsigned MIFlags = 0);
473 void emitThumbRegPlusImmediate(MachineBasicBlock &MBB,
474                                MachineBasicBlock::iterator &MBBI, DebugLoc dl,
475                                unsigned DestReg, unsigned BaseReg,
476                                int NumBytes, const TargetInstrInfo &TII,
477                                const ARMBaseRegisterInfo& MRI,
478                                unsigned MIFlags = 0);
479
480 /// Tries to add registers to the reglist of a given base-updating
481 /// push/pop instruction to adjust the stack by an additional
482 /// NumBytes. This can save a few bytes per function in code-size, but
483 /// obviously generates more memory traffic. As such, it only takes
484 /// effect in functions being optimised for size.
485 bool tryFoldSPUpdateIntoPushPop(const ARMSubtarget &Subtarget,
486                                 MachineFunction &MF, MachineInstr *MI,
487                                 unsigned NumBytes);
488
489 /// rewriteARMFrameIndex / rewriteT2FrameIndex -
490 /// Rewrite MI to access 'Offset' bytes from the FP. Return false if the
491 /// offset could not be handled directly in MI, and return the left-over
492 /// portion by reference.
493 bool rewriteARMFrameIndex(MachineInstr &MI, unsigned FrameRegIdx,
494                           unsigned FrameReg, int &Offset,
495                           const ARMBaseInstrInfo &TII);
496
497 bool rewriteT2FrameIndex(MachineInstr &MI, unsigned FrameRegIdx,
498                          unsigned FrameReg, int &Offset,
499                          const ARMBaseInstrInfo &TII);
500
501 } // End llvm namespace
502
503 #endif